From 310ea90985adcb6d9efe2ab05c67a235c2fb0ea2 Mon Sep 17 00:00:00 2001
From: Griffin Smith <root@gws.fyi>
Date: Sat, 30 Nov 2019 14:13:07 -0500
Subject: Add build and run instructions to the README

just for the heck of it.
---
 README.org | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

(limited to 'README.org')

diff --git a/README.org b/README.org
index 2f766ec1b66e..5d3b2af0485a 100644
--- a/README.org
+++ b/README.org
@@ -1 +1,33 @@
 #+TITLE: Xanthous
+
+* Building
+
+#+BEGIN_SRC shell
+$ nix build
+#+END_SRC
+
+* Running
+
+#+BEGIN_SRC shell
+$ ./result
+#+END_SRC
+
+** Keyboard commands
+
+Keyboard commands are currently undocumented, but can be found in [[[https://github.com/glittershark/xanthous/blob/master/src/Xanthous/Command.hs#L26][this file]].
+Movement uses the nethack-esque hjklybnu.
+
+* Development
+
+#+BEGIN_SRC shell
+$ nix-shell
+
+# Build (for dev)
+[nix-shell:xanthous]$ cabal new-build
+
+# Run tests
+[nix-shell:xanthous]$ cabal new-run test
+
+# Run a repl
+[nix-shell:xanthous]$ cabal new-repl
+#+END_SRC
-- 
cgit 1.4.1