education/rocs/README.packager.md

0001 # Outline
0002
0003 This readme file currently covers the following topics (further topics will be
0004 included in the future):
0005
0006 * [Building](#Building)
0007 * [Licensing](#Licensing)
0008
0009 ## Building
0010
0011 Rocs uses `CMake` as its build system. Please refer to the `CMake` output to see
0012 the list of needed packages and versions.
0013
0014 ## Licenses
0015
0016 Rocs follows the
0017 [KDE Licensing policy](https://community.kde.org/Policies/Licensing_Policy).
0018
0019 ### Source Files
0020
0021  All
0022 `*.cpp`, `*.h`, and `*.cmake` source files are licensed under one of the
0023 following licenses:
0024
0025 - GPL-2
0026 - GPL-2+
0027 - LGPL-2.1
0028
0029 It is a medium term goal to provide all sources under inside `src/` as GPL-2+
0030 and all sources in `libgraphtheory/` as LGPL-2+.
0031
0032 ### Documentation
0033
0034 The documentation files (to be found at: `doc/`) are licensed under GFDL-NIV-1.2+.
0035
0036 ### Test Files
0037
0038 For the automatic unit tests, special test files are provided and are, due to
0039 their license holders, under non GPL-compatible licenses.
0040
0041 These test files are only processed while executing the unit tests and can be
0042 omitted if no unit tests or no unit tests for a specific plugin, respectively,
0043 shall be executed:
0044
0045 - `libgraphtheory/fileformats/dot/autotests/testfiles/`: EPL-1.0
0046   For further information see
0047   `libgraphtheory/fileformats/dot/autotests/testfiles/README`.