CMake

Notice

The documentation below is from upstream CMake. For information about this project, see the wiki_.

.. _the wiki: https://github.com/trentforkert/cmake/wiki

Introduction

CMake is a cross-platform, open-source build system generator. For full documentation visit the CMake Home Page_ and the CMake Documentation Page_.

.. _CMake Home Page: http://www.cmake.org .. _CMake Documentation Page: http://www.cmake.org/cmake/help/documentation.html

CMake is maintained and supported by Kitware_ and developed in collaboration with a productive community of contributors.

.. _Kitware: http://www.kitware.com/cmake

License

CMake is distributed under the OSI-approved BSD 3-clause License. See Copyright.txt_ for details.

.. _Copyright.txt: Copyright.txt

Building CMake

Supported Platforms

MS Windows, Mac OS X, Linux, FreeBSD, Solaris, HP-UX, IRIX, BeOS, QNX

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. Subscribe and post to the CMake Users List_ to ask if others have had experience with the platform.

.. _CMake Users List: http://www.cmake.org/mailman/listinfo/cmake

Building CMake from Scratch

UNIX/Mac OSX/MinGW/MSYS/Cygwin ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You need to have a compiler and a make installed. Run the bootstrap script you find the in the source directory of CMake. You can use the --help option to see the supported options. You may use the --prefix=<install_prefix> option to specify a custom installation directory for CMake. You can run the bootstrap script from within the CMake source directory or any other build directory of your choice. Once this has finished successfully, run make and make install. In summary::

$ ./bootstrap && make && make install

Windows ^^^^^^^

You need to download and install a binary release of CMake in order to build CMake. You can get these releases from the CMake Download Page_ . Then proceed with the instructions below.

.. _CMake Download Page: http://www.cmake.org/cmake/resources/software.html

Building CMake with CMake

You can build CMake as any other project with a CMake-based build system: run the installed CMake on the sources of this CMake with your preferred options and generators. Then build it and install it. For instructions how to do this, see documentation on Running CMake_.

.. _Running CMake: http://www.cmake.org/cmake/help/runningcmake.html

Contributing

See CONTRIBUTING.rst_ for instructions to contribute.

.. _CONTRIBUTING.rst: CONTRIBUTING.rst