cmake/README

   1 cmake
   2 ________________________________________________________________________________
   3
   4 CMake is cross-platform free and open-source software for build automation,
   5 testing, packaging and installation of software by using a compiler-independent
   6 method. CMake is not a build system but rather it generates another system's
   7 build files. It supports directory hierarchies and applications that depend on
   8 multiple libraries. It is used in conjunction with native build environments
   9 such as Make, Qt Creator, Ninja, Android Studio, Apple's Xcode, and Microsoft
  10 Visual Studio. [0]
  11
  12 Upstream: https://cmake.org/
  13
  14
  15 [000] Index
  16 ________________________________________________________________________________
  17
  18 * Installation ........................................................... [001]
  19 * Setup .................................................................. [002]
  20 * Usage .................................................................. [003]
  21 * References ............................................................. [004]
  22
  23
  24 [001] Installation
  25 ________________________________________________________________________________
  26
  27 +------------------------------------------------------------------------------+
  28 |                                                                              |
  29 |  $ kiss b cmake                                                              |
  30 |                                                                              |
  31 +------------------------------------------------------------------------------+
  32
  33
  34 [002] Setup
  35 ________________________________________________________________________________
  36
  37 Cmake supports to output methods on Linux; 'GNU Makefiles' and 'Ninja' with the
  38 former being the default value. These values are set via the CMAKE_GENERATOR
  39 environment variable.
  40
  41 The distribution recommends this value be set to 'Ninja' as it offers a
  42 performance improvement over make and works better with ccache. Set the
  43 following environment variable in your .profile or shell runtime file.
  44
  45 +------------------------------------------------------------------------------+
  46 |                                                                              |
  47 |  $ export CMAKE_GENERATOR=Ninja                                              |
  48 |                                                                              |
  49 +------------------------------------------------------------------------------+
  50
  51
  52 [003] Usage
  53 ________________________________________________________________________________
  54
  55 Refer to the command help output and online documentation. This package does
  56 not yet provide manual pages.
  57
  58
  59 [004] References
  60 ________________________________________________________________________________
  61
  62 [0] https://en.wikipedia.org/wiki/CMake
  63