You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
75 lines
2.2 KiB
Markdown
75 lines
2.2 KiB
Markdown
# Jade GUI
|
|
|
|
The libadwaita/gtk based gui installer using jade as the backend.
|
|
|
|
## 💡 Features
|
|
|
|
- Beatiful UI
|
|
- Easy to use
|
|
- Uses accessible technologies
|
|
|
|
## 🫂 Support
|
|
|
|
**Support** is available in our [Discord](https://getcryst.al/discord) and the [Matrix](https://matrix.to/#/#space:getcryst.al). If you face any issues with the software, feel free to open an issue on this repository.
|
|
|
|
|
|
## 👥 Contributors
|
|
|
|
A list of all **Jade GUI** contributors is available in [CONTRIBUTORS.md](CONTRIBUTORS.md)
|
|
|
|
For a list of **Jade GUI** maintainers specifically, see [.gitlab/CODEOWNERS](.gitlab/CODEOWNERS)
|
|
|
|
|
|
## 💾 Installation
|
|
### 🏗 From Source
|
|
|
|
**Install dependencies**
|
|
|
|
```bash
|
|
# pacman -S jade openssl python-pytz gparted vte4 meson ninja libadwaita desktop-file-utils appstream-glib gtk4
|
|
```
|
|
|
|
**Install jade-GUI from source using `meson` and `ninja`**
|
|
```bash
|
|
$ git clone https://github.com/crystal-linux/jade-gui
|
|
$ cd jade-gui
|
|
$ meson --prefix=/usr _build
|
|
$ ninja -C _build
|
|
$ cd _build
|
|
$ sudo ninja install
|
|
```
|
|
|
|
**Install jade-GUI as a flatpak using `flatpak-builder`** (Recommended for development)
|
|
```sh
|
|
$ git clone https://github.com/crystal-linux/jade-gui
|
|
$ cd jade-gui
|
|
$ flatpak-builder --user --install --install-deps-from=flathub --force-clean build-dir al.getcryst.jadegui.yml
|
|
$ flatpak run al.getcryst.jadegui
|
|
```
|
|
## 📸 Screenshots
|
|
|
|
|
|
|
|
|
|
## 🙌 Contributing
|
|
|
|
If you'd like to contribute to **Jade GUI**, please follow the [Crystal Linux contributing guidelines](https://git.getcryst.al/crystal/info/-/blob/main/CONTRIBUTING.md)!
|
|
|
|
This project uses `meson`, and `ninja` for **Jade GUI** development, please follow the guidelines below:
|
|
|
|
https://pypi.org/project/ninja/
|
|
|
|
https://mesonbuild.com/
|
|
|
|
## 📚 Documentation
|
|
We are also constantly looking for translators for our i18n-enabled projects! If you speak more than one language, consider helping out on our [Weblate](https://i18n.getcryst.al)!
|
|
|
|
|
|
|
|
|
|
## 📜 License
|
|
|
|
[GPLv3-only](https://choosealicense.com/licenses/gpl-3.0/)
|
|
|
|
|