aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'doc/main_page.doxygen')
-rw-r--r--doc/main_page.doxygen11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/main_page.doxygen b/doc/main_page.doxygen
new file mode 100644
index 0000000..35b2b58
--- /dev/null
+++ b/doc/main_page.doxygen
@@ -0,0 +1,11 @@
+/** \mainpage
+
+This is the libbash API documentation.
+
+To find your way around:
+
+- have a look at the API: <a href="namespacelibbash.html">libbash namespace</a>
+- learn how to use the API by example (source code under utils/)
+- find out what syntax we support now (scripts under scripts/)
+
+*/