Various playlist editor developments and fixes.

[dcpomatic.git] / doc / mainpage.txt

diff --git a/doc/mainpage.txt b/doc/mainpage.txt
index a1cd9bac8d7bb9a128b2f1f988ea4fab86e36702..ec1e6ed2df029b2ea9fde59616a54aeadd819981 100644 (file)
--- a/doc/mainpage.txt
+++ b/doc/mainpage.txt
@@ -1,33 +1,26 @@
 /** @mainpage DCP-o-matic
  *
  *  DCP-o-matic is a tool to create digital cinema packages (DCPs) from
- *  video files, or from sets of image files.  It is written in C++
+ *  video files, sets of image files, sound and subtitle files.  It is written in C++
  *  and distributed under the GPL.
  *
- *  Video files are decoded using FFmpeg (http://ffmpeg.org), so any video
- *  supported by FFmpeg should be usable with DCP-o-matic.  DCP-o-matic's output has been
- *  tested on numerous digital projectors.
+ *  More details can be found at https://dcpomatic.com/
  *
- *  DCP-o-matic allows you to crop black borders from movies, scale them to the correct
- *  aspect ratio and apply FFmpeg filters.  The time-consuming encoding of JPEG2000 files
- *  can be parallelised amongst any number of processors on the local host and any number
- *  of servers over a network.
+ *  The source is split into four main parts:
  *
- *  DCP-o-matic can also make DCPs from still images, for advertisements and such-like.
- * 
- *  Parts of DCP-o-matic are based on OpenDCP (http://code.google.com/p/opendcp),
- *  written by Terrence Meiczinger.
+ *  Directory   | Description
+ *  ------------|---------------------------------------------------------------------------------------------
+ *  `src/lib`   | ‘backend’ library with no user interface code.
+ *  `src/wx`    | wxWidgets front end code that is common to all tools.
+ *  `src/tools` | Command line and GUI front-ends for the separate tools (main DCP-o-matic, KDM creator etc.)
+ *  `test`      | Unit tests
  *
- *  DCP-o-matic uses libopenjpeg (http://code.google.com/p/openjpeg/) for JPEG2000 encoding
- *  and libsndfile (http://www.mega-nerd.com/libsndfile/) for WAV file manipulation.  It
- *  also makes heavy use of the boost libraries (http://www.boost.org/).  ImageMagick
- *  (http://www.imagemagick.org/) is used for still-image encoding and decoding, and the GUI is
- *  built using wxWidgets (http://wxwidgets.org/).  It also uses libmhash (http://mhash.sourceforge.net/)
- *  for debugging purposes.
+ * It is build with `waf`, using something like \code
  *
- *  Thanks are due to the authors and communities of all DCP-o-matic's dependencies.
+ * ./waf configure --enable-debug --prefix=/opt
+ * ./waf
+ * sudo ./waf install
  *
- *  Email correspondance is welcome to carl@dcpomatic.com
+ * \endcode
  *
- *  More details can be found at http://dcpomatic.com/
  */