My patches to CMake
Go to file
Brad King 70309e7083 Help: Add documents for release notes
Add a release/index.rst document titled "CMake Release Notes" to hold
the toctree for release notes.  Add a "Release Notes" section to the
top-level html document index to link to the new document.
2014-02-04 11:15:12 -05:00
Auxiliary cmake-mode.el: Add auto-completion to cmake-help-command 2014-01-29 10:23:25 -05:00
Example Remove trailing whitespace from most CMake and C/C++ code 2012-08-13 14:18:39 -04:00
Help Help: Add documents for release notes 2014-02-04 11:15:12 -05:00
Licenses cmake-gui: Reference LGPLv2.1 when redistributing Qt 2013-11-21 11:04:24 -05:00
Modules Merge topic 'cmake-qt-manual' 2014-02-03 11:11:14 -05:00
Source Merge topic 'minor-cleanups' 2014-02-03 11:11:16 -05:00
Templates create_test_sourcelist: Fix linkage in generated test driver code 2013-11-12 09:27:11 -05:00
Tests Merge topic 'fix-visibility-inlines-hidden' 2014-02-03 11:11:11 -05:00
Utilities Utilities/Sphinx: Add option to build 'text' format 2014-02-04 10:29:05 -05:00
.gitattributes Add CMAKE_GNUtoMS option to convert GNU .dll.a to MS .lib 2011-12-05 18:13:49 -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 Configure NSIS-packaged CMake version and install destination 2013-11-12 15:47:06 -05:00
CMakeCPackOptions.cmake.in Configure NSIS-packaged CMake documentation link in Start Menu 2013-11-12 15:47:06 -05:00
CMakeGraphVizOptions.cmake Convert CMake-language commands to lower case 2012-08-13 14:19:16 -04:00
CMakeLists.txt Remove obsolete workaround for old cmake versions. 2014-01-07 16:05:19 +01:00
CMakeLogo.gif ENH: fancier logo 2007-11-26 13:21:57 -05:00
CONTRIBUTING.rst README: Credit Kitware and community of contributors 2014-02-03 11:10:02 -05:00
CTestConfig.cmake Convert CMake-language commands to lower case 2012-08-13 14:19:16 -04:00
CTestCustom.cmake.in CTestCustom: Suppress LNK4089 warning about SHELL32 2014-01-02 14:08:05 -05:00
CTestCustom.ctest.in ENH: Create CTestCustom.cmake instead of CTestCustom.ctest. Create the old file to include the new one for compatibility. This should prevent the long delays of CTest traversing the whole tree looking for CTestCustom.ctest files. 2007-08-31 14:51:09 -04:00
ChangeLog.manual CMake 2.8.12.2 2014-01-16 09:31:28 -05:00
ChangeLog.txt Add new changelog to get ready for release 2009-09-23 16:45:29 -04:00
CompileFlags.cmake Improve ld flags for CMake itself on Linux/HPPA 2014-01-17 09:23:31 -05:00
Copyright.txt Copyright.txt: Update year range to end in 2014 2014-01-02 14:11:55 -05:00
DartConfig.cmake Convert CMake to OSI-approved BSD License 2009-09-28 11:43:28 -04:00
DartLocal.conf.in ENH: remove superior dean i, no longer uses borland 2007-12-03 20:44:43 -05:00
README.rst README: Credit Kitware and community of contributors 2014-02-03 11:10:02 -05:00
bootstrap bootstrap: improve ld flag for Linux/HPPA builds 2014-01-15 10:06:07 -05:00
cmake_uninstall.cmake.in Remove CMake-language block-end command arguments 2012-08-13 14:19:16 -04: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 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