Add readme

justinlovinger · Aug 23, 2023 · bedf402 · bedf402
1 parent 30bbf44
commit bedf402
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,25 @@
+[![Workflow Status](https://github.com/justinlovinger/owm/workflows/build/badge.svg)](https://github.com/justinlovinger/owm/actions?query=workflow%3A%22build%22)
+
+# owm
+
+An experimental [River](https://github.com/riverwm/river) layout generator
+using mathematical optimization
+to invent layouts
+on-the-fly.
+
+## Building
+
+Run `cargo build --release` or `nix build`.
+
+## Usage
+
+Add
+
+```
+riverctl default-layout owm
+owm &
+```
+
+to your River `init`.
+
+See `owm --help` for configuration options.