Updated readme
authorJohn Tsiombikas <nuclear@member.fsf.org>
Wed, 26 Oct 2022 21:52:41 +0000 (00:52 +0300)
committerJohn Tsiombikas <nuclear@member.fsf.org>
Wed, 26 Oct 2022 21:52:41 +0000 (00:52 +0300)
README.md

index 9a9958c..eb2b8b0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,6 +3,16 @@ Attack on Voxelburg
 
 A wip Gameboy Advance game for the gbajam22.
 
+Fly over a 3D terrain, find and destroy all enemy defense pods, before they
+manage to shoot you down. Your final score depends on the difficulty level, time
+it took to take out all the enemy pods, and damage you sustained.
+
+Controls
+--------
+  - D-Pad: turn left/right/up/down.
+  - A: fly forward.
+  - L/R triggers: strafe left/right.
+
 License
 -------
 Copyright (C) 2022 John Tsiombikas <nuclear@mutantstargoat.com>
@@ -11,3 +21,20 @@ This program is free software. Feel free to use, modify, and/or redistribute it
 under the terms of the GNU General Public License v3, or at your option any
 later version published by the Free Software Foundation. See COPYING for
 details.
+
+Build
+-----
+The data files are kept separately on a subversion repository. Grab them with:
+
+    svn co svn://mutantstargoat.com/datadirs/voxelburg data
+
+Alternatively grab a release tarball if available.
+
+To build the game,
+[setup the devkitarm environment](https://devkitpro.org/wiki/Getting_Started),
+and type `make`. Only the basic cross-toolchain, libc and C runtime are required
+from devkitarm. No other libraries are used.
+
+The tools which are part of the build process might have more requirements:
+
+  - **pngdump**: libpng and zlib.