Patched versions of CMake for ReactOS needs
Go to file
Craig Scott 2e3d89a70b Help: Clarify test fixture naming and use
* Make it clearer that fixture names are distinct from test case names.
* Mention -FS, -FC and -FA ctest command line options for overriding
  fixture behavior.

Fixes: #17141
2017-08-08 22:02:07 +10:00
Auxiliary Add directory property 'LABELS' and CMAKE_DIRECTORY_LABELS variable 2017-07-10 16:25:18 -04:00
Help Help: Clarify test fixture naming and use 2017-08-08 22:02:07 +10:00
Licenses cmake-gui: Reference LGPLv3 when redistributing Qt 2016-06-17 15:02:54 -04:00
Modules Merge topic 'FindCygwin-64-bit' 2017-08-04 09:24:25 -04:00
Packaging QtIFW: Improved packaging as part of the QtSDK 2017-04-08 07:13:50 +03:00
Source CMake Nightly Date Stamp 2017-08-08 00:01:06 -04:00
Templates TestDriver: Fix -Wconversion warning 2017-07-14 08:01:26 -04:00
Tests Autogen: Enable per-config support 2017-08-05 14:37:03 +02:00
Utilities Merge topic 'update-libarchive' 2017-08-02 11:45:35 -04:00
.clang-format Configure clang-format for CMake source tree 2016-05-16 16:04:46 -04:00
.clang-tidy clang-tidy: add option CMake_RUN_CLANG_TIDY 2017-05-04 17:39:23 +02:00
.gitattributes clang-format.bash: Use Git attributes to mark files for formatting 2017-02-22 16:59:26 -05:00
.gitignore Update .gitignore 2016-09-12 17:23:50 +02:00
.hooks-config Convert local hook configuration to a Git config file format 2017-01-31 11:16:10 -05:00
bootstrap include_guard: implement new command 2017-06-22 10:53:42 +03:00
cmake_uninstall.cmake.in Replace string(REGEX REPLACE) with string(REPLACE) where possible 2014-04-14 18:17:05 +02:00
CMakeCPack.cmake QtIFW: Improved packaging 2017-01-12 19:29:52 +03:00
CMakeCPackOptions.cmake.in QtIFW: Improved packaging 2017-01-12 19:29:52 +03:00
CMakeGraphVizOptions.cmake Convert CMake-language commands to lower case 2012-08-13 14:19:16 -04:00
CMakeLists.txt LibArchive 2017-07-09 (98a69539) 2017-07-20 11:30:03 -04:00
CMakeLogo.gif ENH: fancier logo 2007-11-26 13:21:57 -05:00
CompileFlags.cmake SunPro: update flags used for CMake itself 2017-05-26 13:26:40 -04:00
configure Simplify bootstrap script source dir detection 2009-09-25 10:48:24 -04:00
CONTRIBUTING.rst CONTRIBUTING: Explain how to propose changes to the release branch 2017-07-21 11:31:59 -04:00
Copyright.txt CPack-FreeBSD: add a generator for FreeBSD pkg(8) 2017-06-10 07:53:59 -04:00
CTestConfig.cmake Simplify CMake per-source license notices 2016-09-27 15:14:44 -04:00
CTestCustom.cmake.in CTestCustom: Suppress warning matched on source file name 2017-06-07 10:46:20 -04: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 README: Update list of supported platforms 2017-06-13 13:05:51 -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
* HP-UX

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