From 71d35e9723c89b9aaa157da336dc7caa025f0dd1 Mon Sep 17 00:00:00 2001
From: fanquake <fanquake@gmail.com>
Date: Sat, 29 Jun 2019 15:00:50 +0800
Subject: [PATCH] Merge #15964: Docs: Improve build-osx document formatting

dbd137a4ea8f1b5dfc5cdc72cee99c8f8328b793 Improve build-osx formatting (Giulio Lombardo)

Pull request description:

  This `PR` will improve `build-osx.md` formatting by:

  1. Updating Markdown syntax to the latest one
  2. Adding syntax highlighting to all code blocks
  3. Aligning the text up to `80` column guideline (before it was following different guidelines, sometime `80`, sometime `90`, etc.)
  4. Small grammar improvements here and there

ACKs for top commit:
  fanquake:
    ACK dbd137a4ea8f1b5dfc5cdc72cee99c8f8328b793 - Document reads and renders essentially the same as the current `build-osx.md`, with minor formatting / grammatical  changes.

Tree-SHA512: 47747991b5fddf0725c82f17f153e83150e51f698787544b4c51b32479989e4b550e2b3aec92979d2b0c76edfdcbbe7c4d9d0115df12e2bfde0cfcb277e9b984
---
 doc/build-osx.md | 73 ++++++++++++++++++++++++++----------------------
 1 file changed, 39 insertions(+), 34 deletions(-)

diff --git a/doc/build-osx.md b/doc/build-osx.md
index 7a2e5711d4..26ec1d32d5 100644
--- a/doc/build-osx.md
+++ b/doc/build-osx.md
@@ -1,73 +1,78 @@
-macOS Build Instructions and Notes
-====================================
-The commands in this guide should be executed in a Terminal application.
-The built-in one is located in `/Applications/Utilities/Terminal.app`.
+# macOS Build Instructions and Notes
 
-Preparation
------------
+The commands in this guide should be executed in a Terminal application.
+The built-in one is located in
+```
+/Applications/Utilities/Terminal.app
+```
+
+## Preparation
 Install the macOS command line tools:
 
-`xcode-select --install`
+```shell
+xcode-select --install
+```
 
 When the popup appears, click `Install`.
 
 Then install [Homebrew](https://brew.sh).
 
-Base build dependencies
------------------------
+## Base build dependencies
 
-```bash
+```shell
 brew install automake libtool pkg-config libnatpmp
 ```
 
 If you want to build the disk image with `make deploy` (.dmg / optional), you need RSVG:
-```bash
+```shell
 brew install librsvg
 ```
 
-Building
---------
+## Building
 
 It's possible that your `PATH` environment variable contains some problematic strings, run
-```bash
+```shell
 export PATH=$(echo "$PATH" | sed -e '/\\/!s/ /\\ /g') # fix whitespaces
 ```
 
 Next, follow the instructions in [build-generic](build-generic.md)
 
-Disable-wallet mode
---------------------
-When the intention is to run only a P2P node without a wallet, Dash Core may be compiled in
-disable-wallet mode with:
-
-    ./configure --disable-wallet
+## `disable-wallet` mode
+When the intention is to run only a P2P node without a wallet, Dash Core may be
+compiled in `disable-wallet` mode with:
+```shell
+./configure --disable-wallet
+```
 
 In this case there is no dependency on Berkeley DB 4.8.
 
 Mining is also possible in disable-wallet mode using the `getblocktemplate` RPC call.
 
-Running
--------
+## Running
 
 Dash Core is now available at `./src/dashd`
 
 Before running, you may create an empty configuration file:
+```shell
+mkdir -p "/Users/${USER}/Library/Application Support/DashCore"
 
-    mkdir -p "/Users/${USER}/Library/Application Support/DashCore"
+touch "/Users/${USER}/Library/Application Support/DashCore/dash.conf"
 
-    touch "/Users/${USER}/Library/Application Support/DashCore/dash.conf"
+chmod 600 "/Users/${USER}/Library/Application Support/DashCore/dash.conf"
+```
 
-    chmod 600 "/Users/${USER}/Library/Application Support/DashCore/dash.conf"
-
-The first time you run dashd, it will start downloading the blockchain. This process could take many hours, or even days on slower than average systems.
+The first time you run dashd, it will start downloading the blockchain. This process could
+take many hours, or even days on slower than average systems.
 
 You can monitor the download process by looking at the debug.log file:
+```shell
+tail -f $HOME/Library/Application\ Support/DashCore/debug.log
+```
 
-    tail -f $HOME/Library/Application\ Support/DashCore/debug.log
+## Other commands:
 
-Other commands:
--------
-
-    ./src/dashd -daemon # Starts the dash daemon.
-    ./src/dash-cli --help # Outputs a list of command-line options.
-    ./src/dash-cli help # Outputs a list of RPC commands when the daemon is running.
+```shell
+./src/dashd -daemon # Starts the dash daemon.
+./src/dash-cli --help # Outputs a list of command-line options.
+./src/dash-cli help # Outputs a list of RPC commands when the daemon is running.
+```