aboutsummaryrefslogtreecommitdiff
path: root/doxygen/mainpage.h
diff options
context:
space:
mode:
Diffstat (limited to 'doxygen/mainpage.h')
-rw-r--r--doxygen/mainpage.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/doxygen/mainpage.h b/doxygen/mainpage.h
new file mode 100644
index 0000000..9b300f2
--- /dev/null
+++ b/doxygen/mainpage.h
@@ -0,0 +1,10 @@
+/** @mainpage Preamble
+ *
+ * Welcome to the documentation for the TinyALSA project.
+ * <br><br>
+ * To start, you may either view the @ref pcm or @ref mixer.
+ * <br><br>
+ * If you find an error in the documentation or an area for improvement,
+ * open an issue or send a pull request to the <a href="https://github.com/tinyalsa/tinyalsa">github page</a>.
+ */
+