summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2023-07-27 14:11:39 (GMT)
committerBrad King <brad.king@kitware.com>2023-07-27 14:15:11 (GMT)
commit803a79dd693ea4001dc82b2646e93bcfa757cb81 (patch)
tree118288f7204c301066c66db89e79f7ae54057f04 /README.rst
parent054ed1c594e27cecee65d1681943d18ad66168f1 (diff)
downloadCMake-803a79dd693ea4001dc82b2646e93bcfa757cb81.zip
CMake-803a79dd693ea4001dc82b2646e93bcfa757cb81.tar.gz
CMake-803a79dd693ea4001dc82b2646e93bcfa757cb81.tar.bz2
README: Update bootstrap example to use 'build' directory under source
When the example was first written, developers commonly placed their build trees as siblings of the source tree. Nowadays many developers use a `build/` directory under the top-level source directory instead. Update the example with the modern convention to avoid requiring the reader to understand that `cmake-source` is a placeholder for the path to the source tree.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index 64e2353..d885740 100644
--- a/README.rst
+++ b/README.rst
@@ -68,8 +68,8 @@ you can build directly in the source tree::
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
+ $ mkdir build && cd build
+ $ ../bootstrap && make
Windows
^^^^^^^