summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..540a1d0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Super Bloom
+
+Super Bloom is a tiny game made for the [Spring Lisp Game Jam
+2023](https://itch.io/jam/spring-lisp-game-jam-2023) using [Guile
+Scheme](https://gnu.org/s/guile), the
+[Chickadee](https://dthompson.us/projects/chickadee.html) game
+library, and the experimental
+[Catbird](https://git.dthompson.us/catbird.git/) game engine.
+
+## Using Guix
+
+We *highly recommend* using [Guix](https://guix.gnu.org/) if you want
+to build this game from source. Once Guix is installed, getting all
+of the dependencies you need to build the game is *easy*. Just run
+`guix shell` from the root directory of this repository and you'll be
+good to go!
+
+## Building from source
+
+Assuming all the dependencies have been installed on your system, the
+game can be built like so:
+
+```
+./boostrap.sh
+./configure
+make -j$(nproc)
+```
+
+## Running the game
+
+To run the game from the source checkout, use the `pre-inst-env` wrapper script:
+
+```
+./pre-inst-env run-game
+```