summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorDavid Thompson <dthompson@vistahigherlearning.com>2021-04-25 21:43:45 -0400
committerDavid Thompson <dthompson@vistahigherlearning.com>2021-04-25 21:43:45 -0400
commit564f7a0eab77d95c623f8df4638b3cbbe794a218 (patch)
tree74d7ccee24a76e3aa6214e51466a577a544f4879 /README
parent4df5aa633b352a8815bbf16d461f46b19b382694 (diff)
Add README.
Diffstat (limited to 'README')
-rw-r--r--README43
1 files changed, 43 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..a5dbdb4
--- /dev/null
+++ b/README
@@ -0,0 +1,43 @@
+-*- org -*-
+
+* The Test Subject
+
+A cheesy point-and-click micro-adventure set in a sci-fi environment.
+Created for the 2021 Spring Lisp Game jam.
+
+** Download (easiest option)
+
+ A pre-built binary bundle for Linux is available at
+ https://davexunit.itch.io/the-test-subject
+
+** Building from source
+*** Using Guix (second easiest option)
+
+ Using the GNU Guix package manager is by far the easiest way get
+ everything you need to build the game from source.
+
+ #+BEGIN_SRC sh
+ guix environment -l guix.scm
+ ./bootstrap
+ ./configure
+ make
+ ./run-game
+ #+END_SRC
+
+*** Using something other than Guix (hard)
+
+ First you'll need to build and install the following Guile libraries:
+
+ - guile-opengl
+ - guile-sdl2
+ - chickadee (from Git: https://git.dthompson.us/chickadee.git)
+ - starling (from Git: https://git.dthompson.us/starling.git)
+
+ Then you can build and run the game:
+
+ #+BEGIN_SRC sh
+ ./bootstrap
+ ./configure
+ make
+ ./run-game
+ #+END_SRC