summaryrefslogtreecommitdiff
path: root/doc/mainpage.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/mainpage.txt')
-rwxr-xr-xdoc/mainpage.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/mainpage.txt b/doc/mainpage.txt
new file mode 100755
index 0000000000..5834a9f63a
--- /dev/null
+++ b/doc/mainpage.txt
@@ -0,0 +1,13 @@
+/** \mainpage Ardour
+ *
+ * Welcome to the in-code documentation for Ardour.
+ *
+ * The main components of Ardour are as follows:
+ * - A GTK2 front-end, in \c gtk2_ardour.
+ * - libardour, the audio-processing back-end, in \c libs/ardour.
+ * - libpbd, a utility library, in \c libs/pbd.
+ *
+ * There are other assorted component libraries:
+ * - gtkmm2ext, an library of extensions to gtkmm2, in \c libs/gtkmm2ext.
+ * - and others...
+ */