INSTALL.md

   1 # nice-lad
   2
   3 ## Building requirements
   4 * CMake >= 2.8.3
   5 * Boost >= 1.57
   6 * Audit >= 2.4.3
   7 * gmock >= 1.7.0 -- required for tests only
   8 * gcc >= 4.8.3 or clang >= 3.4
   9
  10 ## The project was tested using following compilers (Linux distributions)
  11 * gcc 5.1.1 (Fedora 22)
  12 * clang 3.5.0 (Fedora 22)
  13 * gcc 4.9 (Tizen)
  14 * gcc 4.8.4 (Ubuntu 14.04)
  15 * clang 3.4 (Ubuntu 14.04)
  16
  17 ## Building
  18 Following commands should be performed in the source directory.
  19 ```sh
  20 mkdir build
  21 cd build
  22 # With tests
  23 cmake .. [ -DGMOCK_ROOT=/path/to/gmock/root/directory ] [ -DCMAKE_BUILD_TYPE=<mode> ]
  24 # Without tests
  25 cmake .. -DWITH_TESTS=OFF [ -DCMAKE_BUILD_TYPE=<mode> ]
  26 make
  27 ```
  28
  29 ### Build modes
  30 Possible build modes are: RELEASE, DEBUG, CCOV (enables code coverage) and PROFILING
  31 (enables code profiling).
  32
  33 ## Installing
  34 ```sh
  35 make install
  36 ```
  37 To change installing location (add prefix) use CMAKE_INSTALL_PREFIX flag to cmake.
  38
  39 ## Files
  40 The package consists of following files (note, the exact paths are
  41 system-dependent):
  42
  43 * /etc/audisp/plugins.d/nice_lad.conf
  44 * /usr/sbin/nice-lad
  45 * /usr/share/man/man8/nice-lad.8.gz
  46 * /usr/share/man/man8/nice_lad.conf.8.gz
  47