summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEkaitz Zarraga <ekaitz@elenq.tech>2022-11-05 18:23:36 +0100
committerEkaitz Zarraga <ekaitz@elenq.tech>2022-11-05 18:23:36 +0100
commitbde1bcfb5343b7c35363c480d51d9172b4fe18a5 (patch)
tree4d3906090f78dd6aafb92f61a868e44faaaa7b44 /README.md
parentf9e2b69ff2d498627254d95e7e9508cd76048c9c (diff)
Add runner and a README
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0e62f72
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Wake up
+
+Wake up is a simple adventure based on choice. Just select the options in the
+menu and see what happens.
+
+## Dependencies
+
+You need to have `guile` installed.
+
+## Running
+
+Just run the script provided
+
+```
+$ ./run.sh
+```
+
+Or call with guile:
+
+```
+$ guile depre/main.scm
+```