]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc: README.md - format "Tips and Tricks"
authorZac Dover <zac.dover@proton.me>
Fri, 3 Jan 2025 09:23:54 +0000 (19:23 +1000)
committerZac Dover <zac.dover@proton.me>
Fri, 3 Jan 2025 09:23:54 +0000 (19:23 +1000)
Format "Tips and Tricks" into its own section so that it doesn't confuse
readers of the vstart installation procedure.

Signed-off-by: Zac Dover <zac.dover@proton.me>
README.md

index 5a5ac07206d4dc4932d03faed7a06c2a0794be28..3c781e532f320dcc682763416cb55f4de281fe07 100644 (file)
--- a/README.md
+++ b/README.md
@@ -127,18 +127,15 @@ To build Ceph, follow this procedure:
 
        ninja install
 
-    >vstart.sh is commonly used to quickly deploy a development cluster.
-
-    > [TIPS & TRICKS]
-    >
-    >Use Debug Builds Only When Needed 
-    >
-    >While debugging builds are helpful for development, they can slow down performance.
-    >
-    >Use `-DCMAKE_BUILD_TYPE=Release` when debugging isn't necessary.
-    
-    Enable Selective Daemons if you're testing specific components, don't start unnecessary daemons.
-    Preserve Existing Data skip cluster reinitialization between tests by using the `-n` flag
+## Tips and Tricks
+
+   * Use "debug builds" only when needed. Debugging builds are helpful for
+     development, but they can slow down performance. Use
+     `-DCMAKE_BUILD_TYPE=Release` when debugging isn't necessary.
+   * Enable Selective Daemons when testing specific components. Don't start
+     unnecessary daemons.
+   * Preserve Existing Data skip cluster reinitialization between tests by
+     using the `-n` flag.
 
     > [TROUBLESHOOTING]
     >