README.cmake

   1 The Make System
   2 ================
   3
   4 To compile this program using cmake you require cmake 3.3 or newer.
   5
   6 Building
   7 --------
   8 The recommended way is to generate a build directory and build in it, e.g.
   9
  10     mkdir build
  11     cd build
  12     cmake ..        OR cmake -G Ninja ..
  13     make -j4        OR ninja
  14
  15 You can use either the make or the ninja generator; the ninja stuff is faster,
  16 though. You can also build in-tree:
  17
  18     cmake -G Ninja
  19     ninja
  20
  21 To build a subdirectory; for example, apt-pkg, use one of:
  22
  23     ninja apt-pkg/all
  24     make -C apt-pkg -j4    (or cd apt-pkg && make -j4)
  25
  26 Ninja automatically parallelizes, make needs an explicit -j switch. The travis
  27 system uses the make generator, the packaging as well.
  28
  29 TODO
  30 ----
  31
  32 The following features have not been implemented yet:
  33
  34  - documentation
  35  - translation
  36  - unit tests