From: Zac Dover <zac.dover@proton.me>
Date: Fri, 3 Jan 2025 09:23:54 +0000 (+1000)
Subject: doc: README.md - format "Tips and Tricks"
X-Git-Tag: testing/wip-mchangir-testing-PR60889-main-debug~16^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=639cfc5975e11922017f78f2abb2665d17f8fe6c;p=ceph-ci.git

doc: README.md - format "Tips and Tricks"

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>
---

diff --git a/README.md b/README.md
index 5a5ac07206d..3c781e532f3 100644
--- 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]
     >