diff options
| author | Carl Hetherington <cth@carlh.net> | 2017-03-02 15:37:13 +0000 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2017-04-19 23:04:32 +0100 |
| commit | 67a68bd971ebe1b35daa3f75873b4ccb53c00ba0 (patch) | |
| tree | 9b1fea4070c3b15f346cc57075bbeed1b963329d /doc | |
| parent | 3449bc0a6d6e77e851240a0953363f5a07ec6517 (diff) | |
Various Doxygen fixes.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/mainpage.txt | 33 |
1 files changed, 14 insertions, 19 deletions
diff --git a/doc/mainpage.txt b/doc/mainpage.txt index 20d962c8f..81f8a6ee2 100644 --- a/doc/mainpage.txt +++ b/doc/mainpage.txt @@ -1,31 +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 and sound files are decoded using FFmpeg (http://ffmpeg.org), so any file - * supported by FFmpeg should be usable with DCP-o-matic. DCP-o-matic's output has been - * tested on numerous digital projectors. - * - * 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. + * More details can be found at https://dcpomatic.com/ * - * DCP-o-matic can also make DCPs from still images, for advertisements and such-like. + * The source is split into four main parts: * - * 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 ImageMagick (http://www.imagemagick.org/) for still-image encoding and decoding. - * It also uses the boost libraries (http://www.boost.org/) and the GUI is - * built using wxWidgets (http://wxwidgets.org/). + * 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 -j4 + * sudo ./waf install * - * Email correspondance is welcome to carl@dcpomatic.com + * \endcode * - * More details can be found at https://dcpomatic.com/ */ |
