aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5cea861..ed1af7a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,20 @@
+# ZiRC
+
+Learning Zig by building a Raycasting engine (of sorts). Work in
+progress.
+
+## Build
+
+Ensure you have a recent version of Zig (tested on
+`0.9.0-dev.866+6a6e2cd64`), and the `csfml` library somewhere we your
+linker can find it. Then run
+
+`zig build`
+
+followed by
+
+`zig build run`
+
## License
GPLv3+