dash/doc/build-osx.md
MarcoFalke abeafe4488
Merge #14583: docs: Textual improvements in build docs
36c8e68585 Various textual improvements in build docs (Martin Erlandsson)

Pull request description:

  While reading the build docs, I found some opportunities for textual improvements (Force of habit, I used to work as a technical writer...)

  * Added a few missing words, should be uncontroversial.

  * Changed/added some punctuation, for better flow and readability.

  * Fixed one Markdown issue, where two list item headings rendered without a line break. (See image)
  This one needs to be verified after a build, I don't have a proper build environment yet.

  <img width="403" alt="layout_issue" src="https://user-images.githubusercontent.com/453092/47555613-893b4d00-d90c-11e8-8a31-943846059ae7.png">

Tree-SHA512: 1e40a0414e2ce91d223933cca169d3cef25f9d2c606fd75476cef946095eee161f700f9dbf8afe60388ab8c400283d057537266d171ea63125257b7156838ecb
2021-09-24 18:48:44 -04:00

2.0 KiB

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.

Preparation

Install the macOS command line tools:

xcode-select --install

When the popup appears, click Install.

Then install Homebrew.

Base build dependencies

brew install automake libtool pkg-config

If you want to build the disk image with make deploy (.dmg / optional), you need RSVG:

brew install librsvg

Building

It's possible that your PATH environment variable contains some problematic strings, run

export PATH=$(echo "$PATH" | sed -e '/\\/!s/ /\\ /g') # fix whitespaces

Next, follow the instructions in build-generic

Disable-wallet mode

When the intention is to run only a P2P node without a wallet, Bitcoin Core may be compiled in disable-wallet mode with:

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

Dash Core is now available at ./src/dashd

Before running, you may create an empty configuration file:

touch "/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.

You can monitor the download process by looking at the debug.log file:

tail -f $HOME/Library/Application\ Support/DashCore/debug.log

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.