Brad King 6abdc6c16a Merge topic 'update-buildsystem-docs'
cc46b702 Help: Adjust the QtAutogen properties to the common style.
f371545d Help: Use ``True`` and ``False`` for IMPORTED values.
3879c847 Help: Document relation of properties to the rest of the buildsystem.
ba4c2fa8 Help: Mark up the buildsystem commands documentation
a683262a Help: Note that the compatible interface properties must not intersect.
fbe01bed Help: Specify how to order and modify transitively set property values.
645500b4 Help: Add hyperlink targets to some manual sections.
85a4fad7 Help: Use ``inline-literals`` to mark generator expressions.
a0fa0253 Help: Mark up references to NEW and OLD policy settings properly.
6c02e7f4 Help: Add a style guide.
91fbff88 Help: Fix typos
2014-02-06 16:19:02 -05:00
2014-02-06 11:10:18 -05:00
2014-01-16 09:31:28 -05:00
2007-11-26 13:21:57 -05: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`: http://www.cmake.org
.. _`CMake Documentation Page`: http://www.cmake.org/cmake/help/documentation.html

CMake is maintained by `Kitware, Inc.`_ and developed in
collaboration with a productive community of contributors.

.. _`Kitware, Inc.`: http://www.kitware.com

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

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

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

.. _`CONTRIBUTING.rst`: CONTRIBUTING.rst
Description
My patches to CMake
Readme 53 MiB
Languages
C 42.4%
C++ 30.2%
CMake 14.3%
PostScript 5.3%
reStructuredText 4%
Other 3.4%