Preparations for a more presentable online API documentation

libisoburn/trunk/doc/comments

@@ -0,0 +1,58 @@
+/**
+   @author Mario Danic, Thomas Schmitt
+
+   @mainpage Libisoburn Documentation Index
+
+   @section intro Introduction
+
+Libburnia is an open-source project for reading, mastering and writing
+optical discs. This page is about its capability to read, manipulate, and
+write ISO 9660 filesystems with Rock Ridge extensions. Media can be optical
+media or filesystem objects.
+
+Our scope is currently Linux 2.4 and 2.6, or FreeBSD .
+
+libisoburn is an add-on to libburn and libisofs which coordinates both and
+also allows to grow ISO-9660 filesystem images on multi-session media as well
+as on overwriteable media via the same API.
+All media peculiarities are handled automatically.
+
+xorriso is an application of all three libraries which creates, loads,
+manipulates and writes ISO 9660 filesystem images with Rock Ridge extensions.
+Manipulation is not only adding or overwriting of files but also deletion,
+renaming, and attribute changing. An incremental backup feature is provided.
+See xorriso/README for more
+
+SONAME:
+libisoburn.so.1 (since 0.1.0, February 2008).
+
+
+   @section using Using the libraries
+
+Our build system is based on autotools.
+User experience tells us that you will need at least autotools version 1.7.
+
+To build libisoburn go into its toplevel directory and execute
+
+-  ./bootstrap  (needed if you downloaded from SVN)
+
+-  ./configure
+
+-  make
+
+To make the libraries accessible for running resp. developing applications 
+
+-  make install
+
+Read libisoburn/libisoburn.h for a description of the API.
+See also README, xorriso/README, and the man page xorriso/xorriso.1 which
+gives an idea of the capabilities provided by Libburnia.
+
+You will also have to install and understand the two libraries of the 
+Libburnia project which provide fundamental services:
+libburn is the library by which preformatted data get onto optical media.
+See libburn/libburn.h for its API description.
+libisofs is the library to handle ISO 9660 filesystems with Rock Ridge 
+extensions. Its API is described in libisofs/libisofs.h .
+
+*/