Some doc improvements.

1 files changed, 36 insertions, 0 deletions

diff --git a/doc/mainpage.txt b/doc/mainpage.txt
new file mode 100644
index 0000000..642cff6
--- /dev/null
+++ b/doc/mainpage.txt
@@ -0,0 +1,36 @@
+/*!
+
+@mainpage libsub
+
+libsub is a library to read and write subtitles in a variety of formats.  It can be used to read subtitles for
+processing, to write them or to convert between formats.
+
+The current version has reasonable support for the following subtitle formats:
+- Digital Cinema Package (DCP) XML
+- SubRip (.srt)
+- EBU-STL text and binary
+
+
+Reading subtitles
+--
+
+The basic process is:
+
+    shared_ptr<sub::Reader> reader = reader_factory (filename);
+    list<sub::Subtitle> subs = collect<list<sub::Subtitle> > (reader->subtitles ());
+
+We first have:
+
+    shared_ptr<sub::Reader> reader = reader_factory (filename);
+ 
+This looks at the extension of `filename' and, if necessary, its header, and guesses
+what format it is in.  Based on the format it creates an appropriate Reader object.
+This reader object can then return its subtitles using
+
+    reader->subtitles ();
+
+    
+
+
+
+*/