Patched versions of CMake for ReactOS needs
Go to file
Brad King 5ba76299f8 Merge topic 'nolint_typedef_testdriver'
bbbcbb1a48 TestDriver: Disable clang-tidy 'modernize-use-using'

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2118
2018-06-01 09:48:51 -04:00
.github Add GitHub PR template to point contributors at CONTRIBUTING.rst 2017-08-11 08:23:09 -04:00
Auxiliary Various typo fixes 2018-01-04 06:52:01 +11:00
Help Merge topic 'alsa-target' 2018-06-01 09:48:04 -04:00
Licenses cmake-gui: Reference LGPLv3 when redistributing Qt 2016-06-17 15:02:54 -04:00
Modules FindALSA: reformat docs 2018-05-31 09:35:53 +02:00
Packaging QtIFW: Improved packaging as part of the QtSDK 2017-04-08 07:13:50 +03:00
Source CMake Nightly Date Stamp 2018-06-01 00:01:05 -04:00
Templates Merge topic 'nolint_typedef_testdriver' 2018-06-01 09:48:51 -04:00
Tests FindALSA: add testcase 2018-05-31 09:35:53 +02:00
Utilities Merge topic 'update-curl' 2018-05-21 09:53:06 -04:00
.clang-format clang-format: Explicitly require version 3.8 of the tool 2018-05-18 09:19:10 -04:00
.clang-tidy clang-tidy: exclude 'modernize-use-noexcept' introduced in 5.0.0 2017-09-28 07:19:27 -04:00
.gitattributes gitattributes: prefer eol=crlf to -crlf 2017-08-23 13:31:41 -04:00
.gitignore gitignore: Ignore a .vs directory in the source tree 2018-04-05 13:42:42 -04:00
.hooks-config Convert local hook configuration to a Git config file format 2017-01-31 11:16:10 -05:00
bootstrap bootstrap: Use ccache in script-generated makefile 2018-05-25 09:29:53 -04:00
cmake_uninstall.cmake.in Replace string(REGEX REPLACE) with string(REPLACE) where possible 2014-04-14 18:17:05 +02:00
CMakeCPack.cmake CMakeCPack: Exclude version-control-specific files from source package 2017-09-26 08:49:28 -04:00
CMakeCPackOptions.cmake.in CMakeCPack: Exclude version-control-specific files from source package 2017-09-26 08:49:28 -04:00
CMakeGraphVizOptions.cmake Convert CMake-language commands to lower case 2012-08-13 14:19:16 -04:00
CMakeLists.txt IWYU: Define a macro to tell code it is preprocessing for iwyu 2018-05-25 12:46:19 -04:00
CMakeLogo.gif ENH: fancier logo 2007-11-26 13:21:57 -05:00
CompileFlags.cmake CMake: Enable /MP for MSVC toolchain 2018-02-15 10:45:37 -06:00
configure Simplify bootstrap script source dir detection 2009-09-25 10:48:24 -04:00
CONTRIBUTING.rst CONTRIBUTING: Mention GitLab option to allow edits from maintainers 2018-04-12 13:16:38 -04:00
Copyright.txt target_link_libraries: Allow use with targets in other directories 2018-05-15 10:22:35 -04:00
CTestConfig.cmake Simplify CMake per-source license notices 2016-09-27 15:14:44 -04:00
CTestCustom.cmake.in Generators: remove KDevelop3 generator 2018-01-24 08:30:02 -05:00
DartConfig.cmake Simplify CMake per-source license notices 2016-09-27 15:14:44 -04:00
doxygen.config Remove trailing whitespace from most CMake and C/C++ code 2012-08-13 14:18:39 -04:00
README.rst Require C++11 to build CMake itself 2017-08-16 10:13:38 -04:00

CMake
*****

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`: https://cmake.org
.. _`CMake Documentation Page`: https://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
-------------------

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

.. _`CMake Users List`: https://cmake.org/mailman/listinfo/cmake

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=<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`: https://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`: https://cmake.org/cmake/help/runningcmake.html

Reporting Bugs
==============

If you have found a bug:

1. If you have a patch, please read the `CONTRIBUTING.rst`_ document.

2. Otherwise, please join the `CMake Users List`_ and ask about
   the expected and observed behaviors to determine if it is really
   a bug.

3. Finally, if the issue is not resolved by the above steps, open
   an entry in the `CMake Issue Tracker`_.

.. _`CMake Issue Tracker`: https://gitlab.kitware.com/cmake/cmake/issues

Contributing
============

See `CONTRIBUTING.rst`_ for instructions to contribute.

.. _`CONTRIBUTING.rst`: CONTRIBUTING.rst