My patches to CMake
Go to file
Brad King 8576c394b1 Merge branch 'doc-CMAKE_GENERATOR_PLATFORM-typo' into release 2015-06-18 09:18:06 -04:00
Auxiliary bash-completion: Avoid using _init_completion when not defined 2015-04-22 09:40:17 -04:00
Help Merge branch 'doc-CMAKE_GENERATOR_PLATFORM-typo' into release 2015-06-18 09:18:06 -04:00
Licenses cmake-gui: Reference LGPLv2.1 when redistributing Qt 2013-11-21 11:04:24 -05:00
Modules Merge branch 'revert-mingw-no-find_library-dll' into release 2015-06-08 14:18:04 -04:00
Source CMake 3.3.0-rc2 2015-06-09 10:31:54 -04:00
Templates VS: Mark Windows Phone and Store targets as App Containers 2014-09-02 10:17:02 -04:00
Tests Merge topic 'FindPkgConfig_fix_extra_path' 2015-06-01 09:37:34 -04:00
Utilities CMake 3.3.0-rc1 version update 2015-06-02 11:14:25 -04:00
.gitattributes VS: Mark Windows Phone and Store targets as App Containers 2014-09-02 10:17:02 -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 Fix if() checks of CMAKE_SYSTEM_NAME on Cygwin 2014-09-11 21:23:24 +02:00
CMakeCPackOptions.cmake.in Update packaging of CMake for QtIFW 2.0 2015-05-15 11:02:49 -04:00
CMakeGraphVizOptions.cmake Convert CMake-language commands to lower case 2012-08-13 14:19:16 -04:00
CMakeLists.txt KWSys 2015-05-27 (61e0419f) 2015-05-28 08:21:52 -04:00
CMakeLogo.gif ENH: fancier logo 2007-11-26 13:21:57 -05:00
CONTRIBUTING.rst Simplify and clarify credit text and link 2014-06-03 09:24:26 -04:00
CTestConfig.cmake Update CDash server URL 2014-06-24 13:54:52 -04:00
CTestCustom.cmake.in CTestCustom: Suppress HP-UX preprocessor concatenation warning 2015-05-18 09:25:51 -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 2015 2014-12-31 21:09:37 -05:00
DartConfig.cmake Update CDash server URL 2014-06-24 13:54:52 -04:00
README.rst README: Add a section explaining how to report bugs 2014-08-04 09:49:49 -04:00
bootstrap Add option to pass custom flags to sphinx-build (#15545) 2015-04-30 09:41:31 -04: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`: http://www.cmake.org
.. _`CMake Documentation Page`: http://www.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`: http://www.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 the 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`: http://www.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`: http://www.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 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`: http://www.cmake.org/Bug

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

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

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