doc/mainpage.txt

   1 /** @mainpage DCP-o-matic
   2  *
   3  *  DCP-o-matic is a tool to create digital cinema packages (DCPs) from
   4  *  video files, sets of image files, sound and subtitle files.  It is written in C++
   5  *  and distributed under the GPL.
   6  *
   7  *  More details can be found at https://dcpomatic.com/
   8  *
   9  *  The source is split into four main parts:
  10  *
  11  *  Directory   | Description
  12  *  ------------|---------------------------------------------------------------------------------------------
  13  *  `src/lib`   | &lsquo;backend&rsquo; library with no user interface code.
  14  *  `src/wx`    | wxWidgets front end code that is common to all tools.
  15  *  `src/tools` | Command line and GUI front-ends for the separate tools (main DCP-o-matic, KDM creator etc.)
  16  *  `test`      | Unit tests
  17  *
  18  * It is build with `waf`, using something like \code
  19  *
  20  * ./waf configure --enable-debug --prefix=/opt
  21  * ./waf
  22  * sudo ./waf install
  23  *
  24  * \endcode
  25  *
  26  */