aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorvimene <vincent.menegaux@gmail.com>2023-11-19 04:53:31 +0100
committervimene <vincent.menegaux@gmail.com>2023-11-19 04:53:31 +0100
commit47280c41d7bee4964dbd2779de81b8c9bf6133c1 (patch)
tree87af837c2a3b7d53d088826c9d309ca49eb15f59
parent80cd68f89f5abb6a663555ed9dbd01cc4baa8137 (diff)
downloadengine-47280c41d7bee4964dbd2779de81b8c9bf6133c1.tar.gz
added 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