Patched versions of CMake for ReactOS needs
Go to file
Brad King dfe7af3613 Merge topic 'CONTRIBUTING-use-gitlab'
03bd9895 CONTRIBUTING: Document contribution through the Kitware GitLab Instance
2cbfb5c7 CONTRIBUTING: Reference clang-format helper script for code style
2016-09-28 15:38:41 -04:00
Auxiliary Simplify CMake per-source license notices 2016-09-27 15:14:44 -04:00
Help Help: Update cmake-developer(7) module license docs for new notice 2016-09-27 15:18:08 -04:00
Licenses cmake-gui: Reference LGPLv3 when redistributing Qt 2016-06-17 15:02:54 -04:00
Modules Merge topic 'simplify-license-notices' 2016-09-28 08:05:10 -04:00
Packaging Make packaging script wait for the disk image to be mounted. 2016-05-19 11:41:48 -04:00
Source Merge topic 'simplify-license-notices' 2016-09-28 08:05:10 -04:00
Templates Utilities/Release: Drop Cygwin binary 2016-09-12 09:22:50 -04:00
Tests Tests: Update ModuleNotices test for new notice 2016-09-27 15:18:07 -04:00
Utilities Utilities/Release: Add html docs to Windows 64-bit binary 2016-09-28 08:55:29 -04:00
.clang-format Configure clang-format for CMake source tree 2016-05-16 16:04:46 -04:00
.gitattributes Tell Git to use a distinct conflict marker size in .rst files 2016-05-16 16:04:46 -04:00
.gitignore Update .gitignore 2016-09-12 17:23:50 +02:00
.hooks-config.bash Simplify CMake per-source license notices 2016-09-27 15:14:44 -04:00
bootstrap Simplify CMake per-source license notices 2016-09-27 15:14:44 -04:00
cmake_uninstall.cmake.in
CMakeCPack.cmake Simplify CMake per-source license notices 2016-09-27 15:14:44 -04:00
CMakeCPackOptions.cmake.in QtIFW: Developer Reference installation 2016-08-16 19:02:35 +03:00
CMakeGraphVizOptions.cmake
CMakeLists.txt Simplify CMake per-source license notices 2016-09-27 15:14:44 -04:00
CMakeLogo.gif
CompileFlags.cmake Simplify CMake per-source license notices 2016-09-27 15:14:44 -04:00
configure
CONTRIBUTING.rst CONTRIBUTING: Document contribution through the Kitware GitLab Instance 2016-09-28 15:28:06 -04:00
Copyright.txt Copyright.txt: Add notice of copyright by contributors 2016-09-27 15:04:28 -04:00
CTestConfig.cmake Simplify CMake per-source license notices 2016-09-27 15:14:44 -04:00
CTestCustom.cmake.in CTestCustom: Suppress PGI warnings in generated Lexer/Parser code 2016-09-26 14:50:02 -04:00
DartConfig.cmake Simplify CMake per-source license notices 2016-09-27 15:14:44 -04:00
doxygen.config
README.rst README: Update Issue Tracker link to new location 2016-06-17 15:38:07 -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
-------------------

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`: https://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 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