docs(readme): added readme

2025-12-20 13:07:27 -05:00
parent 38d38dc111
commit 9b090a6c1f
1 changed files with 21 additions and 0 deletions
--- a/readme.md
+++ b/readme.md
@@ -0,0 +1,21 @@
+# hadron
+
+Simple rust utility to configure meson build directories in a TUI
+
+## Building
+```bash
+git clone https://github.com/tboudreaux/hadron
+cd hadron
+cargo build --release 
+```
+
+## Usage
+```bash
+hadron buildDir
+```
+
+You will be presented with a list of options for that meson project.
+
+- There are vim like motions to move around
+- space will toggle possible options or open an edit window for free form options
+- / will search