/usr/share/doc/mediascanner/README.md is in libmediascanner-doc 0.3.93+14.04.20131024.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | # Summary
TODO: Describe the module.
## Build Dependencies
* Lucene++ (TODO: Mention our package)
TODO: Later this must maybe be built with this line commented out in its
include/Config.h: #define LPP_USE_ALLOCATOR
* Various parts of boost.
* Google C++ Testing Framework (googletest / gtest).
Ubuntu has this in the libgtest-dev package.
# Building
cd mediascanner
mkdir builddir
cd builddir
cmake ..
(or cmake -DCMAKE_INSTALL_PREFIX:PATH=yourprefix ..)
make
make install
Developers might want to configure cmake like this:
cmake -DENABLE_WARNINGS=ON -DFATAL_WARNINGS=ON -DTMDB_APIKEY="TDB:REPLACE-DUMMY-KEY" .
For real deployment you most get a real API key from http://themoviedb.org/.
# Coverage Reports
This project provides coverage reports for its unit tests. To enable them
configure the project with the "coverage" build type:
cmake -DCMAKE_BUILD_TYPE=coverage
At this point we support [lcov] and [gcovr] reports. They can be generated
by running `make coverage` from the build directory.
The HTML documents from [lcov] provide an easy to read overview on code
coverage of the test suite. They are written to `docs/coverage/index.html`.
The [gcovr] tool is used to generate coverage reports in Coverage's XML format.
They can be used for coverage reports and coverage tracking in Jenkins. The
[gcovr] reports are written to `gcovr.xml`.
[lcov]: http://ltp.sourceforge.net/coverage/lcov.php
[gcovr]: https://software.sandia.gov/trac/fast/wiki/gcovr
|