diff --git a/.github/preview.png b/.github/preview.png new file mode 100644 index 0000000..7e12d9e Binary files /dev/null and b/.github/preview.png differ diff --git a/readme.md b/readme.md index 1aebb7a..baf2809 100644 --- a/readme.md +++ b/readme.md @@ -1,32 +1,53 @@ -## Hyprgui 🚀🦀 +
-- An unofficial GUI made for configuring Hyprland, built with gtk4 and rust. 🚀🦀 -- Comes with a custom-made [hyprparser](https://github.com/nnyyxxxx/hyprparser) for Hyprland's configuration file (made in rust btw). 🦀 +## HyprGUI 🚀🦀 +An unofficial GUI for configuring Hyprland, built with GTK4 and Rust. 🚀🦀
+Comes with a custom [hyprparser](https://github.com/nnyyxxxx/hyprparser) for Hyprland's configuration file. (Rust btw) 🦀 ---- +![Preview](.github/preview.png) -### Example usage: +
+## Installation + +### GitHub Releases +See HyprGUI's [releases page](https://github.com/nnyyxxxx/hyprgui/releases) for downloadable binaries. + +### Arch Linux +There are 2 different [AUR](https://aur.archlinux.org) packages available: + +- [hyprgui](https://aur.archlinux.org/packages/hyprgui) - Latest release built from source +- [hyprgui-bin](https://aur.archlinux.org/packages/hyprgui-bin) - Latest release in binary form + +Install the preferred package with: ```bash -sudo pacman -S --needed rustup git base-devel gtk4 -rustup default stable -git clone https://github.com/nnyyxxxx/hyprgui -cd hyprgui -cargo run +git clone https://aur.archlinux.org/.git +cd +makepkg -si ``` -### Todo: +Or, if you're using an [AUR Helper](https://wiki.archlinux.org/title/AUR_helpers), it's even simpler (using [paru](https://github.com/Morganamilo/paru) as an example): +```bash +paru -S +``` +## Building from source +1. Install Rust (preferably `rustup`) through your distro's package or [the official script](https://www.rust-lang.org/tools/install) +2. Install `git`, `pango` and `gtk4` +3. Clone this repository: +`git clone https://github.com/nnyyxxxx/hyprgui && cd hyprgui` +4. Compile the app with `cargo build --release` or run it directly with `cargo run --release` + +## TODO: - [x] Implement GUI - [x] Implement parser -- [ ] Improve readme +- [x] Improve the readme - [ ] Improve parser - [ ] Improve GUI -### Credits: - -- [Nyx](https://github.com/nnyyxxxx) - For implementing the parser, rest of the GUI, and maintaining the project -- [Adam](https://github.com/adamperkowski) - For implementing the base of the GUI and maintaining the project alongside myself -- [Vaxry](https://github.com/vaxerski) - For Hyprland -- [rust-gtk](https://github.com/gtk-rs/gtk4-rs) - For gtk4 implementation -- [Hyprland](https://github.com/hyprwm/Hyprland) - The window manager \ No newline at end of file +## Credits: +- [Nyx](https://github.com/nnyyxxxx) - Implementing the parser, rest of the GUI, and maintaining the project +- [Adam](https://github.com/adamperkowski) - Implementing the base GUI, maintaining the AUR packages and the project alongside Nyx +- [Vaxry](https://github.com/vaxerski) - Hyprland +- [rust-gtk](https://github.com/gtk-rs/gtk4-rs) - The GTK4 library +- [Hyprland](https://github.com/hyprwm/Hyprland) - The window manager