summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2019-02-20 21:39:11 (GMT)
committerKitware Robot <kwrobot@kitware.com>2019-02-20 21:39:22 (GMT)
commit0ffdcba1789dab86655bc787fc480183467573d4 (patch)
treef35e2bfd3aefec556125dca5753072a8bbad9a2c
parentb76b83efd37a439e22d1d92af3b98c30e8f9ba97 (diff)
parent943a50da55f8d1b25f92dd010c4c54e3b0dfcda7 (diff)
downloadCMake-0ffdcba1789dab86655bc787fc480183467573d4.zip
CMake-0ffdcba1789dab86655bc787fc480183467573d4.tar.gz
CMake-0ffdcba1789dab86655bc787fc480183467573d4.tar.bz2
Merge topic 'readme-build-out-of-source'
943a50da55 README: Suggest bootstrapping out-of-source for development Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Bartosz <gang65@poczta.onet.pl> Merge-request: !2993
-rw-r--r--README.rst21
1 files changed, 13 insertions, 8 deletions
diff --git a/README.rst b/README.rst
index 11bafca..76783ec 100644
--- a/README.rst
+++ b/README.rst
@@ -57,12 +57,19 @@ You need to have a C++ compiler (supporting C++11) and a ``make`` installed.
Run the ``bootstrap`` script you find 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::
+installation directory for CMake. Once this has finished successfully,
+run ``make`` and ``make install``.
- $ ./bootstrap && make && sudo make install
+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
Windows
^^^^^^^
@@ -79,9 +86,7 @@ There are two ways for building CMake under Windows:
$ pacman -S --needed git base-devel mingw-w64-x86_64-gcc
- and bootstrap as above::
-
- $ ./bootstrap && make
+ and bootstrap as above.
.. _`CMake Download Page`: https://cmake.org/cmake/resources/software.html
.. _`MSYS2`: https://www.msys2.org/