aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..98eb222
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# engine
+
+Small graphics engine.
+
+## Building
+
+### Dependencies
+
+- g++ (gcc C++ compiler)
+- GNU make
+- ncurses
+- SDL2
+
+### Actually building
+
+While inside the directory containing all files:
+
+ make
+
+### Running
+
+Usage:
+
+ ./main