README.rst 3.12 KB
Newer Older
1 2 3 4 5 6 7 8
CMake
*****

Introduction
============

CMake is a cross-platform, open-source build system generator.
For full documentation visit the `CMake Home Page`_ and the
9 10
`CMake Documentation Page`_. The `CMake Community Wiki`_ also
references useful guides and recipes.
11

12 13
.. _`CMake Home Page`: https://cmake.org
.. _`CMake Documentation Page`: https://cmake.org/cmake/help/documentation.html
14
.. _`CMake Community Wiki`: https://gitlab.kitware.com/cmake/community/wikis/home
15

16
CMake is maintained and supported by `Kitware`_ and developed in
17 18
collaboration with a productive community of contributors.

19
.. _`Kitware`: http://www.kitware.com/cmake
20

21 22 23 24 25 26 27 28 29 30 31 32 33 34
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
-------------------

35 36 37 38 39 40
* Microsoft Windows
* Apple macOS
* Linux
* FreeBSD
* OpenBSD
* Solaris
41
* AIX
42 43 44 45 46 47

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.

48
.. _`CMake Users List`: https://cmake.org/mailman/listinfo/cmake
49 50 51 52 53 54 55

Building CMake from Scratch
---------------------------

UNIX/Mac OSX/MinGW/MSYS/Cygwin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

56
You need to have a C++ compiler (supporting C++11) and a ``make`` installed.
57
Run the ``bootstrap`` script you find in the source directory of CMake.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
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.

74
.. _`CMake Download Page`: https://cmake.org/cmake/resources/software.html
75 76 77 78 79 80 81 82 83

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`_.

84
.. _`Running CMake`: https://cmake.org/cmake/help/runningcmake.html
85

86 87 88 89 90 91 92
Reporting Bugs
==============

If you have found a bug:

1. If you have a patch, please read the `CONTRIBUTING.rst`_ document.

93
2. Otherwise, please join the `CMake Users List`_ and ask about
94 95 96 97 98 99
   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`_.

100
.. _`CMake Issue Tracker`: https://gitlab.kitware.com/cmake/cmake/issues
101

102 103 104 105 106 107
Contributing
============

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

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