Update readme to reflect changes in project structure

This commit is contained in:
Hannes Kuchelmeister
2022-08-09 14:33:42 +02:00
committed by GitHub
parent c76d36cd1a
commit 9603a3dc4e

View File

@@ -9,20 +9,41 @@ Toolbx Tuner is a tool to improve the experience with [toolbx](https://container
The project is currently only a user-interface concept. The program is not actually usable.
- [x] UI Prototype
- [x] UI prototype
- [x] [Continious development releases](https://github.com/13hannes11/toolbx-tuner/releases/tag/dev)
- [x] Flatpak support
- [ ] [MVP](https://github.com/13hannes11/toolbx-tuner/milestone/1)
- [ ] Flatpak support
- [ ] .desktop file support
- [ ] Publish on Flathub
- [ ] More settings
## Installing the application
The application as of now is only available as a development build. You can download it [here](https://github.com/13hannes11/toolbx-tuner/releases/tag/dev) but be aware of unfinished features and possible instabilities.
## Compiling Source
This project now uses *Gnome Builder* as main build tool and the Flatpak toolchain.
## Recommended: Building using Flatpak
1. Install dependencies:
1. `flatpak install org.flatpak.Builder`
2. `flatpak install org.gnome.Sdk`
3. `flatpak install org.freedesktop.Sdk.Extension.rust-stable`
2. Compile with:
* Flatpak Builder by opening the project folder and pressing run or
* Run `build_install_local.sh`
### Traditional Compilation
1. This project is built with `Relm4`, therefore, the pre-requisits for gtk4 need to be installed. Follow the [gtk4-rs book's](https://gtk-rs.org/gtk4-rs/stable/latest/book/installation_linux.html) installation instructions.
2. Compile with:
* `cargo build` or
* `cargo appimage` (requires `cargo install cargo-appimage`).
* `cargo run`
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.