README.rst

   1 CMake
   2 *****
   3
   4 Introduction
   5 ============
   6
   7 CMake is a cross-platform, open-source build system generator.
   8 For full documentation visit the `CMake Home Page`_ and the
   9 `CMake Documentation Page`_.
  10
  11 .. _`CMake Home Page`: https://cmake.org
  12 .. _`CMake Documentation Page`: https://cmake.org/cmake/help/documentation.html
  13
  14 CMake is maintained and supported by `Kitware`_ and developed in
  15 collaboration with a productive community of contributors.
  16
  17 .. _`Kitware`: http://www.kitware.com/cmake
  18
  19 License
  20 =======
  21
  22 CMake is distributed under the OSI-approved BSD 3-clause License.
  23 See `Copyright.txt`_ for details.
  24
  25 .. _`Copyright.txt`: Copyright.txt
  26
  27 Building CMake
  28 ==============
  29
  30 Supported Platforms
  31 -------------------
  32
  33 * Microsoft Windows
  34 * Apple macOS
  35 * Linux
  36 * FreeBSD
  37 * OpenBSD
  38 * Solaris
  39 * AIX
  40
  41 Other UNIX-like operating systems may work too out of the box, if not
  42 it should not be a major problem to port CMake to this platform.
  43 Subscribe and post to the `CMake Users List`_ to ask if others have
  44 had experience with the platform.
  45
  46 .. _`CMake Users List`: https://cmake.org/mailman/listinfo/cmake
  47
  48 Building CMake from Scratch
  49 ---------------------------
  50
  51 UNIX/Mac OSX/MinGW/MSYS/Cygwin
  52 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  53
  54 You need to have a C++ compiler (supporting C++11) and a ``make`` installed.
  55 Run the ``bootstrap`` script you find in the source directory of CMake.
  56 You can use the ``--help`` option to see the supported options.
  57 You may use the ``--prefix=<install_prefix>`` option to specify a custom
  58 installation directory for CMake. You can run the ``bootstrap`` script from
  59 within the CMake source directory or any other build directory of your
  60 choice. Once this has finished successfully, run ``make`` and
  61 ``make install``.  In summary::
  62
  63  $ ./bootstrap && make && make install
  64
  65 Windows
  66 ^^^^^^^
  67
  68 You need to download and install a binary release of CMake in order to build
  69 CMake.  You can get these releases from the `CMake Download Page`_ .  Then
  70 proceed with the instructions below.
  71
  72 .. _`CMake Download Page`: https://cmake.org/cmake/resources/software.html
  73
  74 Building CMake with CMake
  75 -------------------------
  76
  77 You can build CMake as any other project with a CMake-based build system:
  78 run the installed CMake on the sources of this CMake with your preferred
  79 options and generators. Then build it and install it.
  80 For instructions how to do this, see documentation on `Running CMake`_.
  81
  82 .. _`Running CMake`: https://cmake.org/cmake/help/runningcmake.html
  83
  84 Reporting Bugs
  85 ==============
  86
  87 If you have found a bug:
  88
  89 1. If you have a patch, please read the `CONTRIBUTING.rst`_ document.
  90
  91 2. Otherwise, please join the `CMake Users List`_ and ask about
  92    the expected and observed behaviors to determine if it is really
  93    a bug.
  94
  95 3. Finally, if the issue is not resolved by the above steps, open
  96    an entry in the `CMake Issue Tracker`_.
  97
  98 .. _`CMake Issue Tracker`: https://gitlab.kitware.com/cmake/cmake/issues
  99
 100 Contributing
 101 ============
 102
 103 See `CONTRIBUTING.rst`_ for instructions to contribute.
 104
 105 .. _`CONTRIBUTING.rst`: CONTRIBUTING.rst