aboutsummaryrefslogtreecommitdiff
path: root/src/doc/index.dox
diff options
context:
space:
mode:
Diffstat (limited to 'src/doc/index.dox')
-rw-r--r--src/doc/index.dox24
1 files changed, 24 insertions, 0 deletions
diff --git a/src/doc/index.dox b/src/doc/index.dox
new file mode 100644
index 0000000..342db98
--- /dev/null
+++ b/src/doc/index.dox
@@ -0,0 +1,24 @@
+// vim:ft=doxygen
+/**
+
+\mainpage crêpe game engine
+
+Welcome to the documentation for the crêpe game engine.
+
+\see \ref install "Engine installation instructions"
+\see \ref feature "Example code and usage instructions"
+\see [API documentation](annotated.html)
+
+\noop No bold links in "See also" section
+\htmlonly
+<style> .section.see a { font-weight: normal; } </style>
+\endhtmlonly
+
+*/
+
+/**
+
+\namespace crepe
+\brief Engine namespace
+
+*/