My patches to CMake
Go to file
Brad King a5a5a68572 Merge topic 'doc-3.5-relnotes'
ad701d9f Help: Organize and revise 3.5 release notes
377a12b2 Help: Consolidate 3.5 release notes
2016-02-02 08:33:25 -05:00
Auxiliary cmake-mode.el: unscreamify symbols instead of words 2015-10-08 15:03:11 -04:00
Help Help: Organize and revise 3.5 release notes 2016-02-01 13:38:36 -05:00
Licenses cmake-gui: Reference LGPLv2.1 when redistributing Qt 2013-11-21 11:04:24 -05:00
Modules Merge topic 'FindGit-updates' 2016-02-01 10:43:54 -05:00
Packaging Improve appearance of CMake .dmg package on OS X 2015-11-13 08:46:54 -05:00
Source Merge topic 'remove-stray-semicolon' 2016-02-02 08:33:23 -05:00
Templates VS: Add support for Windows 10 Universal (Store) Applications 2015-10-05 09:48:11 -04:00
Tests Merge topic 'fix-CMAKE_MATCH-self-match' 2016-02-02 08:33:20 -05:00
Utilities Utilities/Release: Configure Windows binary to support Windows XP 2015-12-21 10:05:03 -05:00
.gitattributes KWIML 2015-12-09 (43f9f8d0) 2015-12-17 14:56:38 -05: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: Add CMake_INSTALL_DEPENDENCIES option 2015-07-27 10:30:41 -04:00
CMakeCPackOptions.cmake.in CMake: Mimic NSIS options dialog in WiX installer 2015-12-17 15:57:30 +01:00
CMakeGraphVizOptions.cmake Convert CMake-language commands to lower case 2012-08-13 14:19:16 -04:00
CMakeLists.txt Add option to use a system-installed KWIML 2015-12-18 10:02:28 -05:00
CMakeLogo.gif ENH: fancier logo 2007-11-26 13:21:57 -05:00
CONTRIBUTING.rst Replace http://www.cmake.org URLs with https://cmake.org 2015-09-25 15:47:39 -04:00
CTestConfig.cmake Update CDash server URL 2014-06-24 13:54:52 -04:00
CTestCustom.cmake.in CTestCustom: Suppress -Wshadow warning about Solaris 'single' typedef 2016-01-07 13:44:46 -05: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: Fix typo in wording 2015-10-29 09:25:52 -04:00
bootstrap bootstrap: Add option to build with system liblzma (#15916) 2016-01-13 14:28:02 -05: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://cmake.org/Bug

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

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

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