README.rst 3.85 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
.. _`CMake Home Page`: https://cmake.org
13
.. _`CMake Documentation Page`: https://cmake.org/documentation
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

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.
45
Please post to the `CMake Discourse Forum`_ to ask if others have
46
47
had experience with the platform.

48
.. _`CMake Discourse Forum`: https://discourse.cmake.org
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.
Terrell Russell's avatar
Terrell Russell committed
57
Run the ``bootstrap`` script you find in the source directory of CMake.
58
59
You can use the ``--help`` option to see the supported options.
You may use the ``--prefix=<install_prefix>`` option to specify a custom
60
61
installation directory for CMake.  Once this has finished successfully,
run ``make`` and ``make install``.
62

63
64
65
66
67
68
69
70
71
72
For example, if you simply want to build and install CMake from source,
you can build directly in the source tree::

  $ ./bootstrap && make && sudo make install

Or, if you plan to develop CMake or otherwise run the test suite, create
a separate build tree::

  $ mkdir cmake-build && cd cmake-build
  $ ../cmake-source/bootstrap && make
73
74
75
76

Windows
^^^^^^^

77
78
79
80
81
82
83
84
85
86
87
88
There are two ways for building CMake under Windows:

1. Compile with MSVC from VS 2015 or later.
   You need to download and install a binary release of CMake.  You can get
   these releases from the `CMake Download Page`_.  Then proceed with the
   instructions below for `Building CMake with CMake`_.

2. Bootstrap with MinGW under MSYS2.
   Download and install `MSYS2`_.  Then install the required build tools::

     $ pacman -S --needed git base-devel mingw-w64-x86_64-gcc

89
   and bootstrap as above.
90

91
.. _`CMake Download Page`: https://cmake.org/download
92
.. _`MSYS2`: https://www.msys2.org/
93
94
95
96
97
98
99
100
101

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

102
.. _`Running CMake`: https://cmake.org/runningcmake
103

104
105
106
107
108
109
110
To build the documentation, install `Sphinx`_ and configure CMake with
``-DSPHINX_HTML=ON`` and/or ``-DSPHINX_MAN=ON`` to enable the "html" or
"man" builder.  Add ``-DSPHINX_EXECUTABLE=/path/to/sphinx-build`` if the
tool is not found automatically.

.. _`Sphinx`: http://sphinx-doc.org

111
112
113
114
115
116
117
Reporting Bugs
==============

If you have found a bug:

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

118
2. Otherwise, please post to the `CMake Discourse Forum`_ and ask about
119
120
121
122
123
124
   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`_.

125
.. _`CMake Issue Tracker`: https://gitlab.kitware.com/cmake/cmake/issues
126

127
128
129
130
131
132
Contributing
============

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

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