aboutsummaryrefslogtreecommitdiffstats
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..3140292
--- /dev/null
+++ b/README.org
@@ -0,0 +1,28 @@
+* Cub3D 1.0 - GNU Linux compatible release
+
+** Dependencies
+Required dependencies to build:
+- ~libbsd~
+- ~llvm9+~
+- ~libX11~
+- ~libXext~
+- ~libpthread~
+- ~make~ / ~gmake~
+
+** How to run
+Set the keyboard layout to US English, then:
+
+~make~
+
+~make quest~
+
+~make sergio~
+
+** Controls
+- Movement: ~W-A-S-D~
+- Camera rotation: ~Left-Right~
+- Weapon switch: ~1-2-3~
+- Fire weapon: ~Space~
+- Enable HUD: ~Tab~
+
+* Good luck, hero!