X-Git-Url: https://git.novaco.in/?p=novacoin.git;a=blobdiff_plain;f=doc%2Fbuild-osx.txt;h=0531156f188cbc885505d044150807e369e79a0e;hp=e58efbf88c35156979557d6db6ca9f3f06931c88;hb=cecf7a56ed5a5efd939b21c760c69da616306005;hpb=82f7c20f3c197f820ba742ffa60fb96883609bba diff --git a/doc/build-osx.txt b/doc/build-osx.txt index e58efbf..0531156 100644 --- a/doc/build-osx.txt +++ b/doc/build-osx.txt @@ -1,55 +1,136 @@ -Copyright (c) 2009-2012 Bitcoin Developers -Copyright (c) 2013 NovaCoin Developers -Distributed under the MIT/X11 software license, see the accompanying file -license.txt or http://www.opensource.org/licenses/mit-license.php. This -product includes software developed by the OpenSSL Project for use in the -OpenSSL Toolkit (http://www.openssl.org/). This product includes cryptographic -software written by Eric Young (eay@cryptsoft.com) and UPnP software written by -Thomas Bernard. +Mac OS X Build Instructions and Notes +==================================== +This guide will show you how to build novacoind(headless client) for OSX. +Notes +----- -Mac OS X novacoind build instructions -Laszlo Hanyecz -Douglas Huff +* Tested on OS X 10.7 through 10.10 on 64-bit Intel processors only. +* All of the commands should be executed in a Terminal application. The +built-in one is located in `/Applications/Utilities`. -See readme-qt.rst for instructions on building NovaCoin QT, the -graphical user interface. +Preparation +----------- -Tested on 10.5 and 10.6 intel. PPC is not supported because it's big-endian. +You need to install XCode with all the options checked so that the compiler +and everything is available in /usr not just /Developer. XCode should be +available on your OS X installation media, but if not, you can get the +current version from https://developer.apple.com/xcode/. If you install +Xcode 4.3 or later, you'll need to install its command line tools. This can +be done in `Xcode > Preferences > Downloads > Components` and generally must +be re-done or updated every time Xcode is updated. -All of the commands should be executed in Terminal.app.. it's in -/Applications/Utilities +There's also an assumption that you already have `git` installed. If +not, it's the path of least resistance to install [Github for Mac](https://mac.github.com/) +(OS X 10.7+) or +[Git for OS X](https://code.google.com/p/git-osx-installer/). It is also +available via Homebrew. -You need to install XCode with all the options checked so that the compiler and -everything is available in /usr not just /Developer I think it comes on the DVD -but you can get the current version from http://developer.apple.com +You will also need to install [Homebrew](http://brew.sh) in order to install library +dependencies. +The installation of the actual dependencies is covered in the Instructions +sections below. -1. Clone the github tree to get the source code: +Instructions: Homebrew +---------------------- -git clone https://github.com/novacoin-project/novacoin +#### Install dependencies using Homebrew -2. Download and install MacPorts from http://www.macports.org/ + brew install autoconf automake libtool boost openssl pkg-config protobuf qt qrencode -2a. (for 10.7 Lion) - Edit /opt/local/etc/macports/macports.conf and uncomment "build_arch i386" +#### Installing berkeley-db4 using Homebrew -3. Install dependencies from MacPorts +The homebrew package for berkeley-db4 has been broken for some time. It will install without Java though. -sudo port install boost db48 openssl miniupnpc +Running this command takes you into brew's interactive mode, which allows you to configure, make, and install by hand: +``` +$ brew install https://raw.github.com/mxcl/homebrew/master/Library/Formula/berkeley-db4.rb -–without-java +``` -Optionally install qrencode (and set USE_QRCODE=1): -sudo port install qrencode +The rest of these commands are run inside brew interactive mode: +``` +/private/tmp/berkeley-db4-UGpd0O/db-4.8.30 $ cd .. +/private/tmp/berkeley-db4-UGpd0O $ db-4.8.30/dist/configure --prefix=/usr/local/Cellar/berkeley-db4/4.8.30 --mandir=/usr/local/Cellar/berkeley-db4/4.8.30/share/man --enable-cxx +/private/tmp/berkeley-db4-UGpd0O $ make +/private/tmp/berkeley-db4-UGpd0O $ make install +/private/tmp/berkeley-db4-UGpd0O $ exit +``` -4. Now you should be able to build novacoind: +After exiting, you'll get a warning that the install is keg-only, which means it wasn't symlinked to `/usr/local`. You don't need it to link it to build novacoin, but if you want to, here's how: -cd novacoin/src -make -f makefile.osx + $ brew link --force berkeley-db4 -Run: - ./novacoind --help # for a list of command-line options. -Run - ./novacoind -daemon # to start the novacoin daemon. -Run - ./novacoind help # When the daemon is running, to get a list of RPC commands + +### Building `novacoind` + +1. Clone the github tree to get the source code and go into the directory. + + git clone https://github.com/novacoin-project/novacoin.git + cd novacoin + +2. Build NovaCoin-Qt application: + qmake + make + +3. Build bitcoind: + cd src + make -f makefile.osx novacoind + +Use Qt Creator as IDE +------------------------ +You can use Qt Creator as IDE, for debugging and for manipulating forms, etc. +Download Qt Creator from http://www.qt.io/download/. Download the "community edition" and only install Qt Creator (uncheck the rest during the installation process). + +1. Make sure you installed everything through homebrew mentioned above +2. In Qt Creator do "File" -> "Open Project" +3. Select novacoin-qt.pro as project file. +4. In the "Projects" tab select "Manage Kits..." +5. Select the default "Desktop" kit and select "Clang (x86 64bit in /usr/bin)" as compiler +6. Select LLDB as debugger (you might need to set the path to your installtion) +7. Start debugging with Qt Creator + +Creating a release build +------------------------ +You can ignore this section if you are building `novacoind` for your own use. + +novacoind binary isn't included in the NovaCoin-Qt.app bundle. + +If you are building `novacoind` or `NovaCoin-Qt` for others, your build machine should be set up +as follows for maximum compatibility: + +All dependencies should be compiled with these flags: + + -mmacosx-version-min=10.7 + -arch x86_64 + -isysroot $(xcode-select --print-path)/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.7.sdk + +Once dependencies are compiled, you can create the .dmg disk image: + +./contrib/macdeploy/macdeployqtplus NovaCoin-Qt.app -dmg -fancy ./contrib/macdeploy/fancy.plist + +Running +------- + +It's now available at `./novacoind`, provided that you are still in the `src` +directory. We have to first create the RPC configuration file, though. + +Run `./novacoind` to get the filename where it should be put, or just try these +commands: + + echo -e "rpcuser=novacoinrpc\nrpcpassword=$(xxd -l 16 -p /dev/urandom)" > "/Users/${USER}/Library/Application Support/NovaCoin/novacoin.conf" + chmod 600 "/Users/${USER}/Library/Application Support/NovaCoin/novacoin.conf" + +The next time you run it, it will start downloading the blockchain, but it won't +output anything while it's doing this. This process may take several hours; +you can monitor its process by looking at the debug.log file, like this: + + tail -f $HOME/Library/Application\ Support/NovaCoin/debug.log + +Other commands: +------- + + ./novacoind -daemon # to start the bitcoin daemon. + ./novacoind --help # for a list of command-line options. + ./novacoind help # When the daemon is running, to get a list of RPC commands