docs: add a mainpage file

PatchMixolydic · Nov 16, 2018 · e2554c9 · e2554c9
1 parent 4368bed
commit e2554c9
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/Doxyfile b/Doxyfile
@@ -982,7 +982,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE = 
+USE_MDFILE_AS_MAINPAGE = mainpage.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing

diff --git a/README.md b/README.md
@@ -9,7 +9,4 @@ intend to work on.
 Further documentation can be found at [blackcomb.sparkp.in](http://blackcomb.sparkp.in/).
 
 ## Dependencies
-Blackcomb currently relies on GLAD, GLFW, and stb_image.h.
-
-Some details about the location of these libraries can be configured by CMake.
-The defaults are not guaranteed to be sane.
+Blackcomb currently relies on GLFW and GLM.
diff --git a/mainpage.md b/mainpage.md
@@ -0,0 +1,11 @@
+# Blackcomb
+Blackcomb is intended to be a game engine.
+
+@attention Blackcomb is a work in progress and is still VERY incomplete.
+Don't expect much out of it!
+
+To learn more about Blackcomb's API, check out the [class list](annotated.html).
+
+## Dependencies
+Blackcomb relies on GLFW3 and GLM. Debian and Ubuntu users can
+get these via `sudo apt upgrade && sudo apt install libglfw3-dev libglm-dev`.