DisplayCluster  0.4.0
Documentation.md
1 Documentation {#documentation}
2 ============
3 
4 This document describes the basic structure and provides pointers to
5 auxilary documentation.
6 
7 ## Directory Layout
8 
9 * [CMake](https://github.com/Eyescale/CMake#readme): subdirectory
10  included using git externals. See below for details.
11 * src: Contains the main libraries of the project:
12  * core: The core library.
13  * dcWebservice: Accepts external commands through the FastCGI protocol.
14  * dcstream: Enables streaming pixel content from external applications.
15 * apps: Applications delivered with the project.
16  * DesktopStreamer: A small utility based on dcstream that lets you stream your desktop.
17  * DisplayCluster: The main application.
18  * LocalStreamer: Used by DisplayCluster to generate content from separate processes (sandboxing).
19  * SimpleStreamer: A simple example application which uses the dcstream library.
20 * tests: Unit tests
21 * doc: Doxygen and other documentation.
22 * examples: Example xml configuration files, installed under share/DisplayCluster.
23 * webservice: Configuration files and static content for the webservice.
24 
25 ## CMakeLists
26 
27 The top-level CMakeLists is relatively simple due to the delegation of
28 details into the CMake external. It starts with the project setup which
29 defines the project name and includes the CMake/common git external.
30 
31 ## CMake
32 
33 All BBP projects rely on a common
34 [CMake repository](https://github.com/Eyescale/CMake) which provides
35 sensible defaults for compilation, documentation and packaging. It is
36 integrated as a CMake/common subtree as described in the
37 [Readme](https://github.com/Eyescale/CMake#readme).
38 
39 ## Unit tests
40 
41 Unit tests are very important. Take a look at the
42 [coverage report](CoverageReport/index.html).