README improvements (#8)

* installation instructions

* releases page

* some more

* `gtk` -> `GTK`

* EVEN MORE?!

* typo (?)

* fix typo

* replace outdated pv

---------

Co-authored-by: nyx <nnyyxxxx@protonmail.com>
This commit is contained in:
Adam Perkowski
2024-10-13 11:10:31 +02:00
committed by GitHub
parent 77260e67cb
commit 48a30c52ef
2 changed files with 40 additions and 19 deletions

BIN
.github/preview.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

View File

@@ -1,32 +1,53 @@
## Hyprgui 🚀🦀
<div align='center'>
- 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. 🚀🦀<br>
Comes with a custom [hyprparser](https://github.com/nnyyxxxx/hyprparser) for Hyprland's configuration file. (Rust btw) 🦀
---
![Preview](.github/preview.png)
### Example usage:
</div>
## 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/<package>.git
cd <package>
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 <package>
```
## 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
## 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