2013-06-16 12:29:23 +02:00
Mac OS X Build Instructions and Notes
2012-12-12 17:52:38 +01:00
====================================
2016-05-09 10:30:27 +02:00
The commands in this guide should be executed in a Terminal application.
The built-in one is located in `/Applications/Utilities/Terminal.app` .
2012-12-12 17:52:38 +01:00
Preparation
-----------
2016-06-12 06:59:02 +02:00
Install the OS X command line tools:
2012-12-12 17:52:38 +01:00
2016-06-12 06:59:02 +02:00
`xcode-select --install`
2012-12-12 17:52:38 +01:00
2016-06-12 06:59:02 +02:00
When the popup appears, click `Install` .
2017-04-23 02:47:12 +02:00
Then install [Homebrew ](https://brew.sh ).
2012-12-12 17:52:38 +01:00
2016-05-09 10:30:27 +02:00
Dependencies
2012-12-12 17:52:38 +01:00
----------------------
2017-04-18 14:40:50 +02:00
brew install automake libtool boost --c++11 miniupnpc openssl pkg-config protobuf --c++11 qt5 libevent
brew install berkeley-db # You need to make sure you install a version >= 5.1.29, but as close to 5.1.29 as possible. Check the homebrew docs to find out how to install older versions.
2012-12-12 17:52:38 +01:00
2017-04-23 02:47:12 +02:00
If you want to build the disk image with `make deploy` (.dmg / optional), you need RSVG
2016-12-23 09:52:08 +01:00
brew install librsvg
2016-05-09 10:30:27 +02:00
NOTE: Building with Qt4 is still supported, however, could result in a broken UI. Building with Qt5 is recommended.
2015-01-14 03:10:39 +01:00
2018-01-20 19:35:31 +01:00
Build Dogecoin Core
2016-05-09 10:30:27 +02:00
------------------------
2012-12-12 17:52:38 +01:00
2018-01-20 19:35:31 +01:00
1. Clone the dogecoin source code and cd into `dogecoin`
2012-12-12 17:52:38 +01:00
2018-01-20 19:35:31 +01:00
git clone https://github.com/dogecoin/dogecoin
cd dogecoin
2012-12-12 17:52:38 +01:00
2018-01-20 19:35:31 +01:00
2. Build dogecoin:
2016-05-09 10:30:27 +02:00
2018-01-20 19:35:31 +01:00
Configure and build the headless dogecoin binaries as well as the GUI (if Qt is found).
2016-05-09 10:30:27 +02:00
You can disable the GUI build by passing `--without-gui` to configure.
2012-12-12 17:52:38 +01:00
2013-11-11 04:11:33 +01:00
./autogen.sh
2015-11-17 15:14:36 +01:00
./configure
2013-11-11 04:11:33 +01:00
make
2012-12-12 17:52:38 +01:00
2016-05-09 10:30:27 +02:00
3. It is recommended to build and run the unit tests:
2012-12-12 17:52:38 +01:00
2013-12-11 23:11:21 +01:00
make check
2012-12-12 17:52:38 +01:00
2016-05-09 10:30:27 +02:00
4. You can also create a .dmg that contains the .app bundle (optional):
2012-12-12 17:52:38 +01:00
2016-05-09 10:30:27 +02:00
make deploy
2012-12-12 17:52:38 +01:00
Running
-------
2018-01-20 19:35:31 +01:00
Dogecoin Core is now available at `./src/dogecoind`
2012-12-12 17:52:38 +01:00
2016-05-09 10:30:27 +02:00
Before running, it's recommended you create an RPC configuration file.
2012-12-12 17:52:38 +01:00
2018-01-20 19:35:31 +01:00
echo -e "rpcuser=dogecoinrpc\nrpcpassword=$(xxd -l 16 -p /dev/urandom)" > "/Users/${USER}/Library/Application Support/Dogecoin/dogecoin.conf"
2016-05-09 10:30:27 +02:00
2018-01-20 19:35:31 +01:00
chmod 600 "/Users/${USER}/Library/Application Support/Dogecoin/dogecoin.conf"
2012-12-12 17:52:38 +01:00
2018-01-20 19:35:31 +01:00
The first time you run dogecoind, it will start downloading the blockchain. This process could take several hours.
2016-05-09 10:30:27 +02:00
You can monitor the download process by looking at the debug.log file:
2014-02-26 03:35:48 +01:00
2018-01-20 19:35:31 +01:00
tail -f $HOME/Library/Application\ Support/Dogecoin/debug.log
2012-12-12 17:52:38 +01:00
Other commands:
2014-06-28 10:43:07 +02:00
-------
2012-12-12 17:52:38 +01:00
2018-01-20 19:35:31 +01:00
./src/dogecoind -daemon # Starts the dogecoin daemon.
./src/dogecoin-cli --help # Outputs a list of command-line options.
./src/dogecoin-cli help # Outputs a list of RPC commands when the daemon is running.
2016-05-09 10:30:27 +02:00
Using Qt Creator as IDE
------------------------
2018-01-20 19:35:31 +01:00
You can use Qt Creator as an IDE, for dogecoin development.
2016-05-09 10:30:27 +02:00
Download and install the community edition of [Qt Creator ](https://www.qt.io/download/ ).
Uncheck everything except Qt Creator during the installation process.
2016-04-02 18:54:12 +02:00
2016-05-09 10:30:27 +02:00
1. Make sure you installed everything through Homebrew mentioned above
2. Do a proper ./configure --enable-debug
3. In Qt Creator do "New Project" -> Import Project -> Import Existing Project
2018-01-20 19:35:31 +01:00
4. Enter "dogecoin-qt" as project name, enter src/qt as location
2016-05-09 10:30:27 +02:00
5. Leave the file selection as it is
6. Confirm the "summary page"
7. In the "Projects" tab select "Manage Kits..."
8. Select the default "Desktop" kit and select "Clang (x86 64bit in /usr/bin)" as compiler
9. Select LLDB as debugger (you might need to set the path to your installation)
10. Start debugging with Qt Creator
Notes
-----
2016-10-26 12:04:27 +02:00
* Tested on OS X 10.8 through 10.12 on 64-bit Intel processors only.
2016-04-02 18:54:12 +02:00
2018-01-20 19:35:31 +01:00
* Building with downloaded Qt binaries is not officially supported. See the notes in [#7714 ](https://github.com/dogecoin/dogecoin/issues/7714 )