Skip to content

Commit ae83186

Browse files
committed
docs: rewrite README for scope, install, and features
1 parent b1b0fe4 commit ae83186

1 file changed

Lines changed: 55 additions & 3 deletions

File tree

README.md

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,66 @@
11
# aeris
22

3-
**Unbounded package management** - A universal GUI for managing packages across all your package managers.
3+
**Unbounded package management.** A graphical package manager built with Rust and [GPUI](https://gpui.rs).
44

55
## Overview
66

7-
Aeris is a graphical interface that unifies package management across different systems. Built with Rust and [GPUI](https://gpui.rs), it provides a clean, modern way to search, install, update, and remove packages from multiple sources through a single interface.
7+
Aeris is a desktop GUI for searching, installing, updating, and removing
8+
packages. It talks to package backends through an adapter layer, so a
9+
single interface can eventually front many package managers.
10+
11+
Today the shipping backend is [soar](https://github.com/pkgforge/soar).
12+
A WebAssembly adapter system is included so additional backends can be
13+
added as plugins without rebuilding Aeris. Support for more backends is
14+
planned, not yet complete.
15+
16+
## Features
17+
18+
- Browse and search packages from configured repositories
19+
- Install, update, and remove packages
20+
- View installed packages and available updates
21+
- Declarative manifest view: edit `packages.toml`, preview the diff, and apply
22+
- Per package detail panel with source, build, and option fields
23+
- Live progress for running operations
24+
25+
## Install
26+
27+
### Portable binary (recommended)
28+
29+
Each release ships a single self-contained executable built with
30+
[onelf](https://github.com/QaidVoid/onelf). It bundles its own libraries
31+
and runs on most Linux systems without installing anything.
32+
33+
Download `aeris-x86_64-linux.onelf` from the
34+
[latest release](https://github.com/QaidVoid/aeris/releases/latest),
35+
then:
36+
37+
```sh
38+
chmod +x aeris-x86_64-linux.onelf
39+
./aeris-x86_64-linux.onelf
40+
```
41+
42+
Nightly builds are published on the rolling
43+
[`nightly`](https://github.com/QaidVoid/aeris/releases/tag/nightly) tag.
44+
45+
### From source
46+
47+
Requires a Rust toolchain and the usual GPUI build dependencies
48+
(fontconfig, freetype, libxcb, libxkbcommon, wayland, and alsa headers).
49+
50+
```sh
51+
cargo build --release
52+
./target/release/aeris
53+
```
54+
55+
A Nix flake is provided:
56+
57+
```sh
58+
nix develop
59+
```
860

961
## Contributing
1062

11-
Contributions are welcome! Please feel free to submit issues or pull requests.
63+
Contributions are welcome. Please feel free to open issues or pull requests.
1264

1365
## License
1466

0 commit comments

Comments
 (0)