]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/README.md: improve formatting 59702/head
authorZac Dover <zac.dover@proton.me>
Mon, 9 Sep 2024 15:21:18 +0000 (01:21 +1000)
committerZac Dover <zac.dover@proton.me>
Tue, 10 Sep 2024 09:12:20 +0000 (19:12 +1000)
Improve the formatting of the section "Building Ceph" in the file
README.md.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 7171f73c81d603f8ff62198fc1e5f50c20a0aa05)

README.md

index cb13ab11c41c0a3e662fbdcd8349e6089d6c4821..aaf34e0a56288f6301ceb99841308ab6d8a74bbe 100644 (file)
--- a/README.md
+++ b/README.md
@@ -95,19 +95,19 @@ Using the `-j` option with an argument appropriate to the hardware on which the
 to limit the job number to 3, run the command `ninja -j 3`. On average, each
 `ninja` job run in parallel needs approximately 2.5 GiB of RAM.
 
-This documentation assumes that your build directory is a subdirectory of the
-`ceph.git` checkout. If the build directory is located elsewhere, point
-`CEPH_GIT_DIR` to the correct path of the checkout. Additional CMake args can
-be specified by setting ARGS before invoking ``do_cmake.sh``.  See [cmake
-options](#cmake-options) for more details. For example:
+   This documentation assumes that your build directory is a subdirectory of
+   the `ceph.git` checkout. If the build directory is located elsewhere, point
+   `CEPH_GIT_DIR` to the correct path of the checkout. Additional CMake args 
+   can be specified by setting ARGS before invoking ``do_cmake.sh``. 
+   See [cmake options](#cmake-options) for more details. For example:
 
-    ARGS="-DCMAKE_C_COMPILER=gcc-7" ./do_cmake.sh
+       ARGS="-DCMAKE_C_COMPILER=gcc-7" ./do_cmake.sh
 
-To build only certain targets, run a command of the following form:
+   To build only certain targets, run a command of the following form:
 
        ninja [target name]
 
-To install:
+5. Install the vstart cluster:
 
        ninja install