1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
index e69de29..f0e69a2 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,26 @@
+the reference compiler for the [Crowbar](https://sr.ht/~boringcactus/crowbar-lang/) language.
+
+requirements:
+* [QBE](https://c9x.me/compile/) installed somewhere on your PATH
+* gcc
+
+usage (i probably will forget to update this so [check directly](https://git.sr.ht/~boringcactus/crowbar-reference-compiler/tree/main/crowbar_reference_compiler/__init__.py)):
+```
+usage: crowbarc-reference [-h] [-V] [-g] [--stop-at-parse-tree]
+                          [--stop-at-qbe-ssa] [-S] [-o OUT]
+                          input
+
+The reference compiler for the Crowbar programming language
+
+positional arguments:
+  input                 input file
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -V, --version         show program's version number and exit
+  -g, --include-debug-info
+  --stop-at-parse-tree
+  --stop-at-qbe-ssa
+  -S, --stop-at-assembly
+  -o OUT, --out OUT     output file
+```