This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "CMake".
The branch, master has been updated
via 0ffdcba1789dab86655bc787fc480183467573d4 (commit)
via 943a50da55f8d1b25f92dd010c4c54e3b0dfcda7 (commit)
from b76b83efd37a439e22d1d92af3b98c30e8f9ba97 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=0ffdcba1789dab86655bc787fc480183467573d4
commit 0ffdcba1789dab86655bc787fc480183467573d4
Merge: b76b83e 943a50d
Author: Craig Scott <craig.sc...@crascit.com>
AuthorDate: Wed Feb 20 21:39:11 2019 +0000
Commit: Kitware Robot <kwro...@kitware.com>
CommitDate: Wed Feb 20 16:39:22 2019 -0500
Merge topic 'readme-build-out-of-source'
943a50da55 README: Suggest bootstrapping out-of-source for development
Acked-by: Kitware Robot <kwro...@kitware.com>
Acked-by: Bartosz <gan...@poczta.onet.pl>
Merge-request: !2993
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=943a50da55f8d1b25f92dd010c4c54e3b0dfcda7
commit 943a50da55f8d1b25f92dd010c4c54e3b0dfcda7
Author: Brad King <brad.k...@kitware.com>
AuthorDate: Wed Feb 20 07:56:25 2019 -0500
Commit: Brad King <brad.k...@kitware.com>
CommitDate: Wed Feb 20 08:00:03 2019 -0500
README: Suggest bootstrapping out-of-source for development
Building in-source and running the test suite in-source both leave
many artifacts that we (purposely) do not cover via `.gitignore`.
For developing CMake we typically use out-of-source builds, so
suggest this in the README.
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/
-----------------------------------------------------------------------
Summary of changes:
README.rst | 21 +++++++++++++--------
1 file changed, 13 insertions(+), 8 deletions(-)
hooks/post-receive
--
CMake
_______________________________________________
Cmake-commits mailing list
Cmake-commits@cmake.org
https://cmake.org/mailman/listinfo/cmake-commits
