My patches to CMake
Go to file
Brad King 4bbfea1751 Merge topic 'doc-cross-reference-lang-standard-and-extensions'
c6a077d6 Help: Cross reference CXX_STANDARD and CXX_EXTENSIONS (#16162)
2016-06-28 09:16:38 -04:00
Auxiliary bash-completion: Add cpack --help-{manual,module,policy,property} 2016-06-10 10:46:33 -04:00
Help Merge topic 'doc-cross-reference-lang-standard-and-extensions' 2016-06-28 09:16:38 -04:00
Licenses cmake-gui: Reference LGPLv3 when redistributing Qt 2016-06-17 15:02:54 -04:00
Modules Merge topic 'FindHDF5-handle-unsuffixed' 2016-06-28 09:06:37 -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 'compiler-features' 2016-06-28 09:06:39 -04:00
Templates Drop unnecessary LSRequiresCarbon reference from Info.plist files 2016-03-18 09:47:03 -04:00
Tests Merge topic 'ninja-no-rsp-for-rc' 2016-06-28 09:06:34 -04:00
Utilities Merge topic 'update-libarchive' 2016-06-21 13:57:07 -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
.hooks-config.bash Add pre-commit|commit-msg|prepare-commit-msg hook placeholders 2011-10-24 10:18:36 -04:00
CMakeCPack.cmake cmake-gui: Reference LGPLv3 when redistributing Qt 2016-06-17 15:02:54 -04:00
CMakeCPackOptions.cmake.in CMake: Prevent WiX installations over existing NSIS installations 2016-02-09 10:28:57 -05:00
CMakeGraphVizOptions.cmake Convert CMake-language commands to lower case 2012-08-13 14:19:16 -04:00
CMakeLists.txt Make C++ feature checks extensible 2016-06-27 10:37:40 -04:00
CMakeLogo.gif ENH: fancier logo 2007-11-26 13:21:57 -05:00
CONTRIBUTING.rst CONTRIBUTING: Add a section on coding style 2016-05-16 16:04:46 -04:00
CTestConfig.cmake Update CDash server URL 2014-06-24 13:54:52 -04:00
CTestCustom.cmake.in CTestCustom: Suppress scanbuild warning on unsigned left shift 2016-05-27 09:25:37 -04:00
CompileFlags.cmake Merge topic 'drop-ancient-workarounds' 2015-01-12 08:57:39 -05:00
Copyright.txt Copyright.txt: Update year range to end in 2016 2015-12-31 19:15:34 -05:00
DartConfig.cmake Update CDash server URL 2014-06-24 13:54:52 -04:00
README.rst README: Update Issue Tracker link to new location 2016-06-17 15:38:07 -04:00
bootstrap cxx features: add check for nullptr 2016-06-27 23:24:39 +02:00
cmake_uninstall.cmake.in Replace string(REGEX REPLACE) with string(REPLACE) where possible 2014-04-14 18:17:05 +02:00
configure Simplify bootstrap script source dir detection 2009-09-25 10:48:24 -04:00
doxygen.config Remove trailing whitespace from most CMake and C/C++ code 2012-08-13 14:18:39 -04:00

README.rst

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