diff --git a/doc/build-osx.md b/doc/build-osx.md index 99615062d..9cc8d3ad5 100644 --- a/doc/build-osx.md +++ b/doc/build-osx.md @@ -1,93 +1,93 @@ Mac OS X 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 ----------- 1. Install Xcode from the app store if you don't have it already (it's a dependency for qt5) NOTE: Building with Qt4 is still supported, however, could result in a broken UI. Building with Qt5 is recommended. 2. Install the OS X command line tools: `xcode-select --install` When the popup appears, click `Install`. 3. Install [Homebrew](https://brew.sh). Dependencies ---------------------- Install dependencies: - brew install automake berkeley-db libtool boost miniupnpc openssl pkg-config protobuf python qt libevent + brew install automake berkeley-db libtool boost miniupnpc openssl pkg-config protobuf python qt libevent qrencode See [dependencies.md](dependencies.md) for a complete overview. If you want to build the disk image with `make deploy` (.dmg / optional), you need RSVG brew install librsvg Build Bitcoin ABC ----------------- Before you start building, please make sure that your compiler supports C++14. 1. Clone the Bitcoin ABC source code and cd into `bitcoin-abc` git clone https://github.com/Bitcoin-ABC/bitcoin-abc.git cd bitcoin-abc 2. Build bitcoin-abc: Configure and build the headless bitcoin binaries as well as the GUI (if Qt is found). You can disable the GUI build by passing `--without-gui` to configure. It is recommended to create a build directory to build out-of-tree. ./autogen.sh mkdir build cd build ../configure make 3. It is recommended to build and run the unit tests: make check 4. You can also create a .dmg that contains the .app bundle (optional): make deploy Running ------- Bitcoin ABC is now available at `./src/bitcoind` Before running, it's recommended you create an RPC configuration file. echo -e "rpcuser=bitcoinrpc\nrpcpassword=$(xxd -l 16 -p /dev/urandom)" > "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf" chmod 600 "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf" The first time you run bitcoind, it will start downloading the blockchain. This process could take several hours. You can monitor the download process by looking at the debug.log file: tail -f $HOME/Library/Application\ Support/Bitcoin/debug.log Other commands: ------- ./src/bitcoind -daemon # Starts the bitcoin daemon. ./src/bitcoin-cli --help # Outputs a list of command-line options. ./src/bitcoin-cli help # Outputs a list of RPC commands when the daemon is running. Notes ----- * Building with downloaded Qt binaries is not officially supported. See the notes in [#7714](https://github.com/bitcoin/bitcoin/issues/7714)