|
1 | 1 | <div align="center"> |
2 | 2 |
|
3 | 3 | # ∞ aeternum |
4 | | - <sub>A simple and minimal upscaler built in rust (WIP)</sub> |
| 4 | + <sub>A simple and minimal upscaler built in rust</sub> |
5 | 5 |
|
6 | 6 | <img src="./assets/dev_preview_2.png"> |
7 | | - |
8 | | - <sub>(Image from a **WIP** development build, the final product may differ.)</sub> |
9 | 7 | </div> |
10 | 8 |
|
11 | | -> [!CAUTION] |
12 | | -> This project is HEAVILY a work in progress. Github issues are very welcome. 🤝 |
13 | | -
|
14 | 9 | # What is Aeternum? |
15 | | -Aeternum (lt.: "Eternal") is a simple, minimal but yet feature-rich image upscaler using [`upscayl-ncnn`](https://github.com/upscayl/upscayl-ncnn) as it's backend. |
| 10 | +Aeternum (lt.: "Eternal") is a simple and minimal image upscaler using [`upscayl-ncnn`](https://github.com/upscayl/upscayl-ncnn) as it's backend. |
16 | 11 | Aeternum is built using [`rust`](https://www.rust-lang.org) and [`egui`](https://github.com/emilk/egui). |
17 | 12 |
|
18 | 13 | # 🛠️ Installation |
19 | | -WIP |
| 14 | +## 🪟 Windows 10+ |
| 15 | +1. Download the setup (or the zip if you want it portable) from [the newest release](https://github.com/cloudy-org/aeternum/releases/latest). |
| 16 | +2. Run the setup/Extract the zip. |
| 17 | +3. Run aeternum. |
| 18 | +4. Enjoy :) |
20 | 19 |
|
21 | | -## 🏗 Build from source |
22 | | -### Prerequisites: |
23 | | -- [Rust](https://www.rust-lang.org/tools/install) and Cargo (Rust **`1.81.0`**+ is required!). |
24 | | -- [upscayl-ncnn](https://github.com/upscayl/upscayl-ncnn) |
| 20 | +## 🐧 Linux |
25 | 21 |
|
26 | | -- Linux dependecies for [eframe](https://crates.io/crates/eframe): |
27 | | - - [libxcb](https://archlinux.org/packages/extra/x86_64/libxcb/) |
28 | | - - [libxkbcommon](https://archlinux.org/packages/extra/x86_64/libxkbcommon/) |
29 | | - - [openssl](https://archlinux.org/packages/core/x86_64/openssl/) |
| 22 | +### Packaged |
| 23 | +> Packaged versions of aeternum are available but they are ***third-party*** except for the AUR package. It's maintained by us. |
| 24 | +> |
| 25 | +> [](https://repology.org/project/aeternum/versions) |
30 | 26 |
|
31 | | -1. Clone the repo. |
32 | | -```sh |
33 | | -git clone https://github.com/cloudy-org/aeternum |
34 | | -cd aeternum |
35 | | -``` |
36 | | -2. Pull the cirrus tool kit submodule. |
37 | | -```sh |
38 | | -git submodule update --init --recursive |
39 | | -``` |
| 27 | +### ZIP |
40 | 28 |
|
41 | | -#### ⚙️ For Development |
42 | | -At this stage, for development, you would just run ``cargo run``. If you would like to install it to your system continue ahead to the [next section](#-install-into-your-system). |
| 29 | +1. Download the zip from [the newest release](https://github.com/cloudy-org/aeternum/releases/latest). |
| 30 | +2. Extract the zip |
| 31 | +3. `cd` into the folder and run aeternum: `./aeternum` |
| 32 | +4. Enjoy :) |
43 | 33 |
|
44 | | -4. Run dev binary. |
45 | | -```sh |
46 | | -cargo run |
47 | | -``` |
48 | | -To run Aeternum in development with an image, append `--` and pass an image path after like so: |
49 | | -```sh |
50 | | -cargo run -- ./tsukasa.jpg |
51 | | -``` |
52 | | -To run with verbose debugging, call cargo run with the `RUST_LOG=DEBUG` environment variable: |
53 | | -```sh |
54 | | -RUST_LOG=DEBUG cargo run -- ./tsukasa.jpg |
55 | | -``` |
56 | | -``` |
57 | | -[2024-12-24T11:14:00Z DEBUG aeternum] Using image: 'tsukasa.jpg' |
58 | | -[2024-12-24T11:14:00Z DEBUG eframe] Using the glow renderer |
59 | | -[2024-12-24T11:14:00Z DEBUG sctk] Bound new global [65] wl_output v4 |
60 | | -[2024-12-24T11:14:00Z DEBUG sctk] Bound new global [66] wl_output v4 |
61 | | -[2024-12-24T11:14:00Z DEBUG sctk] Bound new global [31] zxdg_output_manager_v1 v3 |
62 | | -[2024-12-24T11:14:00Z DEBUG sctk] Bound new global [10] wl_seat v7 |
63 | | -
|
64 | | -... (truncated for the sanity of this readme) |
65 | | -``` |
66 | | - |
67 | | -#### 🎀 Install into your system. |
68 | | -Soon™ |
| 34 | +## 🍎 MacOS |
| 35 | +WIP |
0 commit comments