Kitware / CMake

CMake ***** Introduction ============ CMake is a cross-platform, open-source build system generator. For full documentation visit the _ and the _. The _ also references useful guides and recipes. .. _ : https://cmake.org .. _ : https://cmake.org/documentation .. _ : https://gitlab.kitware.com/cmake/community/-/wikis/home CMake is maintained and supported by _ and developed in collaboration with a productive community of contributors. .. _ : https://www.kitware.com/cmake License ======= CMake is distributed under the OSI-approved BSD 3-clause License. See _ for details. .. _ : LICENSE.rst Building CMake ============== Supported Platforms ------------------- • Microsoft Windows • Apple macOS • Linux • FreeBSD • OpenBSD • Solaris • AIX Other UNIX-like operating systems may work too out of the box, if not it should not be a major problem to port CMake to this platform. Please post to the _ to ask if others have had experience with the platform. .. _ : https://discourse.cmake.org Building CMake with CMake ------------------------- You can build CMake as any other project with a CMake-based build system: run an already-installed CMake on this source tree with your preferred generator and options. Then build it and install it. To build the documentation, install _ and configure CMake with -DSPHINX_HTML=ON and/or -DSPHINX_MAN=ON to enable the "html" or "man" builder. Add -DSPHINX_EXECUTABLE=/path/to/sphinx-build if the tool is not found automatically. To run the test suite, run ctest in the CMake build directory after building. See the _ for details. .. _ : https://sphinx-doc.org .. _ : Help/dev/testing.rst Building CMake from Scratch --------------------------- UNIX/Mac OSX/MinGW/MSYS/Cygwin ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ You need to have a C++ compiler (supporting C++11) and a make installed. Run the bootstrap script you find in the source directory of CMake. You can use the --help option to see the supported options. You may use the --prefix= option to specify a custom installation directory for CMake. Once this has finished successfully, run make and make install . For example, if you simply want to build and install CMake from source, you can build directly in the source tree:: $ ./bootstrap && make && sudo make install Or, if you plan to develop CMake or otherwise run the test suite, create a separate build tree:: $ mkdir build && cd build $ ../bootstrap && make Windows ^^^^^^^ There are two ways for building CMake under Windows: • Compile with MSVC from VS 2015 or later. You need to download and install a binary release of CMake. You can get these releases from the _. Then proceed with the instructions above for _. • Bootstrap with MinGW under MSYS2. Download and install _. Then install the required build tools:: $ pacman -S --needed git base-devel mingw-w64-x86_64-gcc and bootstrap as above. .. _ : https://cmake.org/download .. _ : https://www.msys2.org/ Reporting Bugs ============== If you have found a bug: • If you have a patch, please read the _ document. • Otherwise, please post to the _ and ask about the expected and observed behaviors to determine if it is really a bug. • Finally, if the issue is not resolved by the above steps, open an entry in the _. .. _ : https://gitlab.kitware.com/cmake/cmake/-/issues Contributing ============ See _ for instructions to contribute. .. _ : CONTRIBUTING.rst