Skip to content

Commit

Permalink
Update Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
VidereLicet committed Mar 16, 2016
1 parent 8033661 commit 1f03254
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 0 deletions.
File renamed without changes.
79 changes: 79 additions & 0 deletions doc/build-linux
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
Dependencies
------------

Library Purpose Description
------- ------- -----------
libssl SSL Support Secure communications
libdb4.8 Berkeley DB Blockchain & wallet storage
libboost Boost C++ Library
miniupnpc UPnP Support Optional firewall-jumping support
libqrencode QRCode generation Optional QRCode generation


Compile Options
------------

miniupnpc may be used for UPnP port mapping.
Set USE_UPNP to a different value to control this:
USE_UPNP=- No UPnP support - miniupnp not required
USE_UPNP=0 (the default) UPnP support turned off by default at runtime
USE_UPNP=1 UPnP support turned on by default at runtime

libqrencode may be used for QRCode image generation.
Set USE_QRCODE to control this:
USE_QRCODE=0 (the default) No QRCode support - libqrcode not required
USE_QRCODE=1 QRCode support enabled

Licenses of statically linked libraries:
Berkeley DB New BSD license with additional requirement that linked
software must be free open source
Boost MIT-like license
miniupnpc New (3-clause) BSD license


Dependency Build Instructions: Ubuntu & Debian
----------------------------------------------

First ensure you have build essentials installed:
sudo apt-get install build-essentials

Install Boost:
sudo apt-get install libboost-all-dev

Install Berklee DB:
sudo apt-get install libdb-dev libdb++-dev

Install Open SSL:
sudo apt-get install libssl-dev

Install Mini UPNP
sudo apt-get install libminiupnpc-dev

Install QrenCode:
sudo apt-get install libqrencode-dev

For the Qt, install QT Framework:
sudo apt-get install qt4-qmake libqt4-dev

Build Instructions (Daemon): Ubuntu & Debian
----------------------------------------------
cd ~
git clone https://github.com/Nexusoft/Nexus.git Nexus
cd Nexus
make -f makefile.unix

To Execute:
./nexus


Build Instructions (Qt): Ubuntu & Debian
----------------------------------------------
cd ~
git clone https://github.com/Nexusoft/Nexus.git Nexus
cd Nexus
qmake nexus-qt.pro "RELEASE=1" "USE_UPNP=1"
make

To Execute:
./nexus-qt

File renamed without changes.

0 comments on commit 1f03254

Please sign in to comment.