summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorsanine-a <sanine.not@pm.me>2020-05-24 18:47:03 -0500
committersanine-a <sanine.not@pm.me>2020-05-24 18:47:03 -0500
commit3a6bab4f4119ead6c84c1de70c15cf26c5b85b81 (patch)
tree7905e126e63f4baba36bf0d6688aba1f06b116cf /README.md
parent86bd56a8983b664e145ddd3b34a2c2fa8bdf21a9 (diff)
add README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..30bf901
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Honey Engine
+
+This is a 3D game engine written in C. It is a personal project, so while *I* will probably
+use it for some projects, I can't reccommend that others do the same unless you're ready
+to really dig into the source code.
+
+## Installation
+
+The Honey engine requires
+
+* OpenGL 3.3+
+* GLFW3
+* cglm
+* assimp
+
+To install:
+
+```
+cmake .
+make
+```