You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

132 lines
3.8 KiB

  1. CMake
  2. *****
  3. Introduction
  4. ============
  5. CMake is a cross-platform, open-source build system generator.
  6. For full documentation visit the `CMake Home Page`_ and the
  7. `CMake Documentation Page`_. The `CMake Community Wiki`_ also
  8. references useful guides and recipes.
  9. .. _`CMake Home Page`: https://cmake.org
  10. .. _`CMake Documentation Page`: https://cmake.org/documentation
  11. .. _`CMake Community Wiki`: https://gitlab.kitware.com/cmake/community/-/wikis/home
  12. CMake is maintained and supported by `Kitware`_ and developed in
  13. collaboration with a productive community of contributors.
  14. .. _`Kitware`: https://www.kitware.com/cmake
  15. License
  16. =======
  17. CMake is distributed under the OSI-approved BSD 3-clause License.
  18. See `Copyright.txt`_ for details.
  19. .. _`Copyright.txt`: Copyright.txt
  20. Building CMake
  21. ==============
  22. Supported Platforms
  23. -------------------
  24. * Microsoft Windows
  25. * Apple macOS
  26. * Linux
  27. * FreeBSD
  28. * OpenBSD
  29. * Solaris
  30. * AIX
  31. Other UNIX-like operating systems may work too out of the box, if not
  32. it should not be a major problem to port CMake to this platform.
  33. Please post to the `CMake Discourse Forum`_ to ask if others have
  34. had experience with the platform.
  35. .. _`CMake Discourse Forum`: https://discourse.cmake.org
  36. Building CMake with CMake
  37. -------------------------
  38. You can build CMake as any other project with a CMake-based build system:
  39. run the installed CMake on the sources of this CMake with your preferred
  40. options and generators. Then build it and install it.
  41. For instructions how to do this, see documentation on `Running CMake`_.
  42. .. _`Running CMake`: https://cmake.org/runningcmake
  43. To build the documentation, install `Sphinx`_ and configure CMake with
  44. ``-DSPHINX_HTML=ON`` and/or ``-DSPHINX_MAN=ON`` to enable the "html" or
  45. "man" builder. Add ``-DSPHINX_EXECUTABLE=/path/to/sphinx-build`` if the
  46. tool is not found automatically.
  47. .. _`Sphinx`: https://sphinx-doc.org
  48. Building CMake from Scratch
  49. ---------------------------
  50. UNIX/Mac OSX/MinGW/MSYS/Cygwin
  51. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  52. You need to have a C++ compiler (supporting C++11) and a ``make`` installed.
  53. Run the ``bootstrap`` script you find in the source directory of CMake.
  54. You can use the ``--help`` option to see the supported options.
  55. You may use the ``--prefix=<install_prefix>`` option to specify a custom
  56. installation directory for CMake. Once this has finished successfully,
  57. run ``make`` and ``make install``.
  58. For example, if you simply want to build and install CMake from source,
  59. you can build directly in the source tree::
  60. $ ./bootstrap && make && sudo make install
  61. Or, if you plan to develop CMake or otherwise run the test suite, create
  62. a separate build tree::
  63. $ mkdir build && cd build
  64. $ ../bootstrap && make
  65. Windows
  66. ^^^^^^^
  67. There are two ways for building CMake under Windows:
  68. 1. Compile with MSVC from VS 2015 or later.
  69. You need to download and install a binary release of CMake. You can get
  70. these releases from the `CMake Download Page`_. Then proceed with the
  71. instructions above for `Building CMake with CMake`_.
  72. 2. Bootstrap with MinGW under MSYS2.
  73. Download and install `MSYS2`_. Then install the required build tools::
  74. $ pacman -S --needed git base-devel mingw-w64-x86_64-gcc
  75. and bootstrap as above.
  76. .. _`CMake Download Page`: https://cmake.org/download
  77. .. _`MSYS2`: https://www.msys2.org/
  78. Reporting Bugs
  79. ==============
  80. If you have found a bug:
  81. 1. If you have a patch, please read the `CONTRIBUTING.rst`_ document.
  82. 2. Otherwise, please post to the `CMake Discourse Forum`_ and ask about
  83. the expected and observed behaviors to determine if it is really
  84. a bug.
  85. 3. Finally, if the issue is not resolved by the above steps, open
  86. an entry in the `CMake Issue Tracker`_.
  87. .. _`CMake Issue Tracker`: https://gitlab.kitware.com/cmake/cmake/-/issues
  88. Contributing
  89. ============
  90. See `CONTRIBUTING.rst`_ for instructions to contribute.
  91. .. _`CONTRIBUTING.rst`: CONTRIBUTING.rst