created drocks

1 files changed, 21 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..c990be5
--- /dev/null
+++ b/README
@@ -0,0 +1,21 @@
+# drocks
+
+A little dlang game about rocks. [See the
+python original](https://git.hrhr.dev/rocks).
+
+## Running
+
+I haven't made any packages or whatnot of this app, so you're going to
+have to compile from source. https://dlang.org should have some advice
+for installing a compiler and the dub package manager. Once you've got
+that, run `dub run` and you're playing rocks! (you may also see an error
+if your system doesn't have ncurses for some reason)
+
+## Controls
+
+Controls should eventually be configurable, but for the moment, the
+arrow keys are for movement and [space] picks up and sets down rocks.
+
+## License
+
+This code is made available under the GPLv3 license.