]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/README.md - add ordered list 59799/head
authorZac Dover <zac.dover@proton.me>
Mon, 5 Aug 2024 13:02:49 +0000 (23:02 +1000)
committerZac Dover <zac.dover@proton.me>
Sun, 15 Sep 2024 11:14:57 +0000 (21:14 +1000)
Add ordered-list formatting to the "Building Ceph" section of README.md.

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

README.md

index 4b144b16a1632fd97b325842df06e28635a2317a..2fadda20366fd68410f8f7ee5242c7c889eeb1bb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -72,12 +72,19 @@ we recommend that you build `.deb` or `.rpm` packages, or refer to
 ``ceph.spec.in`` or ``debian/rules`` to see which configuration options are
 specified for production builds.
 
-To build Ceph, make sure that you are in the top-level `ceph` directory that
-contains `do_cmake.sh` and `CONTRIBUTING.rst` and run the following commands:
+To build Ceph, follow this procedure: 
 
-       ./do_cmake.sh
-       cd build
-       ninja
+1. Make sure that you are in the top-level `ceph` directory that
+   contains `do_cmake.sh` and `CONTRIBUTING.rst`.
+2. Run the `do_cmake.sh` script:
+
+    >``./do_cmake.sh``
+3. Move into the `build` directory:
+
+    >``cd build``
+4. Use the `ninja` buildsystem to build the development environment:
+
+    >``ninja``
 
 ``do_cmake.sh`` by default creates a "debug build" of Ceph, which can be up to
 five times slower than a non-debug build.  Pass