aboutsummaryrefslogtreecommitdiffstats
path: root/docs/main.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/main.md')
-rw-r--r--docs/main.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/main.md b/docs/main.md
new file mode 100644
index 00000000..1373b39d
--- /dev/null
+++ b/docs/main.md
@@ -0,0 +1,20 @@
+YAGE {#mainpage}
+====
+
+YAGE (Yet Another Game Engine) is a game engine that was written to learn about graphics
+and eventually be used to program games. It focuses mostly on tile based 2D games
+but it will eventually be expanded to handle orthographic views and finally full 3D.
+
+Guides
+------
+
+Below are some guides for different aspects of the game engine and how to use it.
+
+- [Sprite Batching](@ref spritebatch_guide): Used to draw efficient 2D sprites and tiles.
+- [Logger](@ref logger_guide): Asynchronous logger.
+
+License
+-------
+
+Copyright (c) 2017 Yann Herklotz Grave <ymherklotz@gmail.com>
+MIT License, see LICENSE file for more details.