summaryrefslogtreecommitdiff
path: root/daemons/maap/doc/mainpage.dox
diff options
context:
space:
mode:
Diffstat (limited to 'daemons/maap/doc/mainpage.dox')
-rw-r--r--daemons/maap/doc/mainpage.dox24
1 files changed, 24 insertions, 0 deletions
diff --git a/daemons/maap/doc/mainpage.dox b/daemons/maap/doc/mainpage.dox
new file mode 100644
index 00000000..dc073157
--- /dev/null
+++ b/daemons/maap/doc/mainpage.dox
@@ -0,0 +1,24 @@
+/**
+ * \mainpage MAAP Documentation
+ *
+ * Introduction
+ * ------------
+ * This is a MAAP implementation. Details will be provided soon.
+ *
+ * Linux Specific
+ * -------------
+ *
+ * Requirements for documentation on a ubuntu based system:
+ * - cmake: sudo apt-get install cmake
+ * - doxygen: sudo apt-get install doxygen
+ *
+ * To build, execute the linux/build makefile.
+ *
+ * To execute, run ./maap_daemon
+ *
+ * Windows Version
+ * ---------------
+ *
+ * Windows is not supported.
+*/
+