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`_. The `CMake Community Wiki`_ also
10 references useful guides and recipes.
12 .. _`CMake Home Page`: https://cmake.org
13 .. _`CMake Documentation Page`: https://cmake.org/cmake/help/documentation.html
14 .. _`CMake Community Wiki`: https://gitlab.kitware.com/cmake/community/wikis/home
16 CMake is maintained and supported by `Kitware`_ and developed in
17 collaboration with a productive community of contributors.
19 .. _`Kitware`: http://www.kitware.com/cmake
24 CMake is distributed under the OSI-approved BSD 3-clause License.
25 See `Copyright.txt`_ for details.
27 .. _`Copyright.txt`: Copyright.txt
43 Other UNIX-like operating systems may work too out of the box, if not
44 it should not be a major problem to port CMake to this platform.
45 Subscribe and post to the `CMake Users List`_ to ask if others have
46 had experience with the platform.
48 .. _`CMake Users List`: https://cmake.org/mailman/listinfo/cmake
50 Building CMake from Scratch
51 ---------------------------
53 UNIX/Mac OSX/MinGW/MSYS/Cygwin
54 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
56 You need to have a C++ compiler (supporting C++11) and a ``make`` installed.
57 Run the ``bootstrap`` script you find in the source directory of CMake.
58 You can use the ``--help`` option to see the supported options.
59 You may use the ``--prefix=<install_prefix>`` option to specify a custom
60 installation directory for CMake. You can run the ``bootstrap`` script from
61 within the CMake source directory or any other build directory of your
62 choice. Once this has finished successfully, run ``make`` and
63 ``make install``. In summary::
65 $ ./bootstrap && make && make install
70 You need to download and install a binary release of CMake in order to build
71 CMake. You can get these releases from the `CMake Download Page`_ . Then
72 proceed with the instructions below.
74 .. _`CMake Download Page`: https://cmake.org/cmake/resources/software.html
76 Building CMake with CMake
77 -------------------------
79 You can build CMake as any other project with a CMake-based build system:
80 run the installed CMake on the sources of this CMake with your preferred
81 options and generators. Then build it and install it.
82 For instructions how to do this, see documentation on `Running CMake`_.
84 .. _`Running CMake`: https://cmake.org/cmake/help/runningcmake.html
89 If you have found a bug:
91 1. If you have a patch, please read the `CONTRIBUTING.rst`_ document.
93 2. Otherwise, please join the `CMake Users List`_ and ask about
94 the expected and observed behaviors to determine if it is really
97 3. Finally, if the issue is not resolved by the above steps, open
98 an entry in the `CMake Issue Tracker`_.
100 .. _`CMake Issue Tracker`: https://gitlab.kitware.com/cmake/cmake/issues
105 See `CONTRIBUTING.rst`_ for instructions to contribute.
107 .. _`CONTRIBUTING.rst`: CONTRIBUTING.rst