mirror of
https://github.com/13hannes11/toolbx-tuner.git
synced 2024-09-03 23:21:00 +02:00
50 lines
1.7 KiB
Markdown
50 lines
1.7 KiB
Markdown
|
|
# Toolbx Tuner
|
|
|
|
Toolbx Tuner is a tool to improve the experience with [toolbx](https://containertoolbx.org/).
|
|
|
|
|
|
|
|
## Project Roadmap
|
|
|
|
The project is currently only a user-interface concept. The program is not actually usable.
|
|
|
|
- [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)
|
|
- [ ] 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 run`
|
|
|
|
## Contributing
|
|
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|