summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e2f454d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+## Build instructions
+
+```sh
+cmake -B build
+make -C build
+```
+
+Pass `-DCMAKE_BUILD_TYPE=Debug` or `-DCMAKE_BUILD_TYPE=Release` to
+`cmake` to select the according build configuration.
+
+This builds a CLI that can be then found in `./build/bin/katja`.