Add README.md

Cargo.toml

@@ -4,11 +4,11 @@ version = "0.1.0"
 edition = "2024"
 
 [[bin]]
-name = "jmb-bar"
+name = "jmbbar"
 path = "src/main.rs"
 
 [[bin]]
-name = "ctl"
+name = "jmbctl"
 path = "src/ctl.rs"
 
 [dependencies]

README.md

@@ -0,0 +1,44 @@
+# jmb-bar
+... is a status bar, action center and app launcher. It is built for wayland and hyprland.
+Additionally, it acts as an idle daemon. It is written in rust and uses Gtk 4 and 
+gtk-layer-shell. 
+**This is a hobby project and for my own personal use. It might be unoptimized in 
+some places and naively implemented. It is also most definitely not very customizable 
+and highly opinionated. Use at your own risk.**
+
+### Building and Running
+To build the project you need the rust compiler and cargo installed.
+See here: [https://rust-lang.org/tools/install/](https://rust-lang.org/tools/install/).
+
+First clone the project:
+```bash
+git clone https://git.jmb19905.net/jmb05/jmb-bar
+```
+
+switch to the project directory:
+```bash
+cd jmb-bar
+```
+
+To build run:
+```bash
+cargo build --bins --release
+```
+
+this build two executables in the `target/release/` the `jmbbar` executable launches
+the bar and `jmbctl` can be used to query state and send commands.
+
+Using:
+```bash
+cargo install --bins
+```
+installs the binaries to `~/.cargo/bin`. If you have that path in you `PATH` variable
+you can run the executables from anywhere.
+
+### Usage
+
+#### Starting the bar
+`jmbbar` or `./jmbbar` (depending on your installation location)
+
+#### Controlling
+- `jmbctl menu` opens the app launcher

src/main.rs

@@ -5,7 +5,6 @@ mod css;
 mod ctl;
 mod ui;
 
-use crate::config::Config;
 use glib::clone;
 use gtk::prelude::*;
 use gtk::{Application, CssProvider, gdk, gio};