Update build manuals
[novacoin.git] / doc / build-osx.txt
index 0531156..337fff9 100644 (file)
-Mac OS X Build Instructions and Notes
-====================================
-This guide will show you how to build novacoind(headless client) for OSX.
-
-Notes
------
-
-* 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`.
-
-Preparation
------------
-
-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.
-
-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 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.
+Copyright (c) 2017-2019 42 Developers
+Copyright (c) 2019 NovaCoin Developers
 
-Instructions: Homebrew
-----------------------
-
-#### Install dependencies using Homebrew
-
-        brew install autoconf automake libtool boost openssl pkg-config protobuf qt qrencode
-
-#### Installing berkeley-db4 using Homebrew
-
-The homebrew package for berkeley-db4 has been broken for some time.  It will install without Java though.
-
-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 
-```
-
-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
-```
-
-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:
-
-    $ brew link --force berkeley-db4
+Mac OS X Build Instructions and Notes
+=====================================
 
+MacOS 10.11.6 - El Capitan was used in this manual. All of the commands should be executed in a Terminal application. The built-in one is located in /Applications/Utilities. 
 
-### Building `novacoind`
+1. Install Xcode (7.3.1 for El Capitan), run it and accept the license agreement:
 
-1. Clone the github tree to get the source code and go into the directory.
+https://developer.apple.com/xcode/
 
-        git clone https://github.com/novacoin-project/novacoin.git
-        cd novacoin
+Install Xcode command line tools:
 
-2. Build NovaCoin-Qt application:
-        qmake
-        make
+xcode-select --install
 
-3. Build bitcoind:
-        cd src
-        make -f makefile.osx novacoind
+2. Install MacPorts with main dependencies:
 
-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).
+https://distfiles.macports.org/MacPorts/MacPorts-2.3.5-10.11-ElCapitan.pkg
 
-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
+sudo port install autoconf automake libtool pkgconfig db60 openssl qrencode qt5
 
-Creating a release build
-------------------------
-You can ignore this section if you are building `novacoind` for your own use.
+sudo ln -s /opt/local/libexec/qt5/bin/qmake /opt/local/bin/qmake
 
-novacoind binary isn't included in the NovaCoin-Qt.app bundle.
+3. Install Homebrew(http://brew.sh) with dependencies:
 
-If you are building `novacoind` or `NovaCoin-Qt` for others, your build machine should be set up
-as follows for maximum compatibility:
+/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
 
-All dependencies should be compiled with these flags:
+brew install python2 boost@1.60
 
- -mmacosx-version-min=10.7
- -arch x86_64
- -isysroot $(xcode-select --print-path)/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.7.sdk
+brew link --force boost@1.60
 
-Once dependencies are compiled, you can create the .dmg disk image:
+4. Add to PATH:
 
-./contrib/macdeploy/macdeployqtplus NovaCoin-Qt.app -dmg -fancy ./contrib/macdeploy/fancy.plist
+nano ~/.profile
 
-Running
--------
+export PATH=$PATH:~/opt/local/lib/db6.0
+export PATH=$PATH:~/opt/local/lib/db60/include
+export PATH=$PATH:~/usr/local/Cellar/boost@1.60/1.60.0/include/boost/thread.hpp
 
-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.
+Ctrl+O, Enter, Ctrl+X
 
-Run `./novacoind` to get the filename where it should be put, or just try these
-commands:
+5. Clone the github tree:
 
-    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"
+git clone https://github.com/novacoin-project/novacoin.git
 
-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:
+6. Build novacoin-Qt application:
 
-    tail -f $HOME/Library/Application\ Support/NovaCoin/debug.log
+cd novacoin
+qmake
+make
 
-Other commands:
--------
+7. Create the .dmg disk image:
 
-    ./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
+sudo easy_install appscript
+./contrib/macdeploy/macdeployqtplus novacoin-Qt.app -dmg -fancy ./contrib/macdeploy/fancy.plist
\ No newline at end of file