Skip to content

Commit 46753b1

Browse files
fanquakeMunkybooty
authored andcommitted
Merge bitcoin#15964: Docs: Improve build-osx document formatting
dbd137a 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 dbd137a - Document reads and renders essentially the same as the current `build-osx.md`, with minor formatting / grammatical changes. Tree-SHA512: 47747991b5fddf0725c82f17f153e83150e51f698787544b4c51b32479989e4b550e2b3aec92979d2b0c76edfdcbbe7c4d9d0115df12e2bfde0cfcb277e9b984
1 parent 473c5ba commit 46753b1

File tree

1 file changed

+26
-19
lines changed

1 file changed

+26
-19
lines changed

doc/build-osx.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
1-
macOS Build Instructions and Notes
2-
====================================
1+
# macOS Build Instructions and Notes
2+
33
The commands in this guide should be executed in a Terminal application.
4-
The built-in one is located in `/Applications/Utilities/Terminal.app`.
4+
The built-in one is located in
5+
```
6+
/Applications/Utilities/Terminal.app
7+
```
58

6-
Preparation
7-
-----------
9+
## Preparation
810
Install the macOS command line tools:
911

10-
`xcode-select --install`
12+
```shell
13+
xcode-select --install
14+
```
1115

1216
When the popup appears, click `Install`.
1317

@@ -35,12 +39,12 @@ export PATH=$(echo "$PATH" | sed -e '/\\/!s/ /\\ /g') # fix whitespaces
3539

3640
Next, follow the instructions in [build-generic](build-generic.md)
3741

38-
Disable-wallet mode
39-
--------------------
40-
When the intention is to run only a P2P node without a wallet, Dash Core may be compiled in
41-
disable-wallet mode with:
42-
43-
./configure --disable-wallet
42+
## `disable-wallet` mode
43+
When the intention is to run only a P2P node without a wallet, Dash Core may be
44+
compiled in `disable-wallet` mode with:
45+
```shell
46+
./configure --disable-wallet
47+
```
4448

4549
In this case there is no dependency on Berkeley DB 4.8.
4650

@@ -52,18 +56,21 @@ Running
5256
Dash Core is now available at `./src/dashd`
5357

5458
Before running, you may create an empty configuration file:
59+
```shell
60+
mkdir -p "/Users/${USER}/Library/Application Support/DashCore"
5561

56-
mkdir -p "/Users/${USER}/Library/Application Support/DashCore"
57-
58-
touch "/Users/${USER}/Library/Application Support/DashCore/dash.conf"
62+
touch "/Users/${USER}/Library/Application Support/DashCore/dash.conf"
5963

60-
chmod 600 "/Users/${USER}/Library/Application Support/DashCore/dash.conf"
64+
chmod 600 "/Users/${USER}/Library/Application Support/DashCore/dash.conf"
65+
```
6166

62-
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.
67+
The first time you run dashd, it will start downloading the blockchain. This process could
68+
take many hours, or even days on slower than average systems.
6369

6470
You can monitor the download process by looking at the debug.log file:
65-
66-
tail -f $HOME/Library/Application\ Support/DashCore/debug.log
71+
```shell
72+
tail -f $HOME/Library/Application\ Support/DashCore/debug.log
73+
```
6774

6875
Other commands:
6976
-------

0 commit comments

Comments
 (0)