From b95416572ac5bbe115c6b4ac4d7e0f583076a86f Mon Sep 17 00:00:00 2001
From: Hannes Kuchelmeister <13hannes11@users.noreply.github.com>
Date: Mon, 18 Apr 2022 13:55:40 +0200
Subject: [PATCH] Create README.md

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..37d7654
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+
+# Toolbx Tuner
+
+Toolbx Tuner is a tool to improve the experience with [toolbx](containertoolbx.org/).
+
+![image](https://user-images.githubusercontent.com/9381167/163803291-91a53046-85c3-4ba1-8f3b-1ecd29343e89.png)
+
+## Project Roadmap
+
+The project is currently only a user-interface concept. The program is not actually usable.
+
+- [x] UI Prototype
+- [ ] [MVP](https://github.com/13hannes11/toolbx-tuner/milestone/1)
+- [ ] Flatpak support
+- [ ] .desktop file support
+- [ ] More settings
+
+
+
+## Compiling Source
+
+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`).
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.