summaryrefslogtreecommitdiff
path: root/doc/mainpage.txt
diff options
context:
space:
mode:
authorCarl Hetherington <carl@carlh.net>2010-04-15 13:55:32 +0000
committerCarl Hetherington <carl@carlh.net>2010-04-15 13:55:32 +0000
commitd2beb38ea9fb39dbfb8667784bd248b32d171cbf (patch)
tree35e8bd8ef2e727d877d082e82362f40ec763bc69 /doc/mainpage.txt
parent307e82f9bea4a90e821dda6b1099685a3ec8a83d (diff)
Add a couple of bits of documentation.
git-svn-id: svn://localhost/ardour2/branches/3.0@6908 d708f5d6-7413-0410-9779-e7cbd77b26cf
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...
+ */