922a43bd23ad3c8854bb39f87dee77065634a16a
[novacoin.git] / build-unix.txt
1 Copyright (c) 2009-2010 Satoshi Nakamoto
2 Distributed under the MIT/X11 software license, see the accompanying
3 file license.txt or http://www.opensource.org/licenses/mit-license.php.
4 This product includes software developed by the OpenSSL Project for use in
5 the OpenSSL Toolkit (http://www.openssl.org/).  This product includes
6 cryptographic software written by Eric Young (eay@cryptsoft.com) and UPnP
7 software written by Thomas Bernard.
8
9
10 UNIX BUILD NOTES
11 ================
12
13 To Build
14 --------
15
16 make -f makefile.unix            # Bitcoin with wxWidgets GUI
17   or
18 make -f makefile.unix bitcoind   # Headless bitcoin
19
20
21 Dependencies
22 ------------
23 sudo apt-get install build-essential
24 sudo apt-get install libgtk2.0-dev
25 sudo apt-get install libssl-dev
26 sudo apt-get install libdb4.7-dev
27 sudo apt-get install libdb4.7++-dev
28 Boost 1.40+: sudo apt-get install libboost-all-dev
29 or Boost 1.37: sudo apt-get install libboost1.37-dev
30
31 If using Boost 1.37, append -mt to the boost libraries in the makefile.
32
33 Requires wxWidgets 2.9.0 or greater, which uses UTF-8.  Don't try 2.8, it
34 won't work.
35
36 You need to download wxWidgets from http://www.wxwidgets.org/downloads/
37 and build it yourself.  See the build instructions and configure parameters
38 below.
39
40 Requires miniupnpc for UPnP port mapping.  It can be downloaded from
41 http://miniupnp.tuxfamily.org/files/.  UPnP support is compiled in and
42 turned off by default.  Set USE_UPNP to a different value to control this:
43 USE_UPNP=   no UPnP support, miniupnp not required;
44 USE_UPNP=0  (the default) UPnP support turned off by default at runtime;
45 USE_UPNP=1  UPnP support turned on by default at runtime.
46
47 Licenses of statically linked libraries:
48 wxWidgets      LGPL 2.1 with very liberal exceptions
49 Berkeley DB    New BSD license with additional requirement that linked software must be free open source
50 Boost          MIT-like license
51 miniupnpc      New (3-clause) BSD license
52
53 Versions used in this release:
54 GCC          4.3.3
55 OpenSSL      0.9.8g
56 wxWidgets    2.9.0
57 Berkeley DB  4.7.25.NC
58 Boost        1.37
59 miniupnpc    1.5
60
61
62 Notes
63 -----
64 The UI layout is edited with wxFormBuilder.  The project file is
65 uiproject.fbp.  It generates uibase.cpp and uibase.h, which define base
66 classes that do the rote work of constructing all the UI elements.
67
68 The release is built with GCC and then "strip bitcoin" to strip the debug
69 symbols, which reduces the executable size by about 90%.
70
71
72 wxWidgets
73 ---------
74 cd /usr/local
75 tar -xzvf wxWidgets-2.9.0.tar.gz
76 cd wxWidgets-2.9.0
77 mkdir buildgtk
78 cd buildgtk
79 ../configure --with-gtk --enable-debug --disable-shared --enable-monolithic --without-libpng --disable-svg
80 make
81 sudo su
82 make install
83 ldconfig
84
85
86 miniupnpc
87 ---------
88 tar -xzvf miniupnpc-1.5.tar.gz
89 cd miniupnpc-1.5
90 make
91 sudo su
92 make install
93
94
95 Berkeley DB
96 -----------
97 You need Berkeley DB 4.7.  Don't use 4.8, the database/log0000* files
98 are incompatible.  If you have to build Berkeley DB yourself:
99 ../dist/configure --enable-cxx
100 make
101
102
103 Boost
104 -----
105 If you need to build Boost yourself:
106 sudo su
107 ./bootstrap.sh
108 ./bjam install