summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 52ea41f..4761d75 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,20 @@
# Simple3DEngine
A simple 3D engine written in C with integer math (fixed-point)
+
+## Requirements
+* Make
+* Gcc
+* SDL2 (If on ubuntu follow [these instructions](https://gist.github.com/BoredBored/3187339a99f7786c25075d4d9c80fad5))
+
+## Running
+Simply ```cd``` into ```src``` and ```make```!
+
+Use W and S to move the cubes forward and back, arrow keys to move up/down, left/right.
+
+Use Q and E to change X-Axis Rotation
+
+Use A and D to change Y-Axis Rotation
+
+Use Z and C to change Z-Axis Rotation
+
+![Demo](https://s7.gifyu.com/images/simplescreenrecorder-2020-08-04_23.46.35.gif)