aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/build-osx.md18
-rw-r--r--doc/build-unix.md43
2 files changed, 41 insertions, 20 deletions
diff --git a/doc/build-osx.md b/doc/build-osx.md
index c79c1317b0..491c5c4683 100644
--- a/doc/build-osx.md
+++ b/doc/build-osx.md
@@ -38,7 +38,7 @@ Instructions: Homebrew
#### Install dependencies using Homebrew
- brew install autoconf automake libtool boost miniupnpc openssl pkg-config protobuf qt
+ brew install autoconf automake libtool boost miniupnpc openssl pkg-config protobuf qt gmp
#### Installing berkeley-db4 using Homebrew
@@ -84,6 +84,22 @@ After exiting, you'll get a warning that the install is keg-only, which means it
make install
+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. Do a proper ./configure --with-gui=qt5 --enable-debug
+3. In Qt Creator do "New Project" -> Import Project -> Import Existing Project
+4. Enter "bitcoin-qt" as project name, enter src/qt as location
+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 installtion)
+10. Start debugging with Qt Creator
+
Creating a release build
------------------------
You can ignore this section if you are building `bitcoind` for your own use.
diff --git a/doc/build-unix.md b/doc/build-unix.md
index fb5eaec431..e03dc8181a 100644
--- a/doc/build-unix.md
+++ b/doc/build-unix.md
@@ -27,31 +27,25 @@ This will build bitcoin-qt as well if the dependencies are met.
Dependencies
---------------------
+These dependencies are required:
+
Library | Purpose | Description
------------|------------------|----------------------
libssl | SSL Support | Secure communications
- libdb4.8 | Berkeley DB | Wallet storage
libboost | Boost | C++ Library
- miniupnpc | UPnP Support | Optional firewall-jumping support
- qt | GUI | GUI toolkit
- protobuf | Payments in GUI | Data interchange format used for payment protocol
- libqrencode | QR codes in GUI | Optional for generating QR codes
-
-[miniupnpc](http://miniupnp.free.fr/) may be used for UPnP port mapping. It can be downloaded from [here](
-http://miniupnp.tuxfamily.org/files/). UPnP support is compiled in and
-turned off by default. See the configure options for upnp behavior desired:
+ libgmp | secp256k1 | Arbitrary-precision arithmetic (version >= 3.1)
- --without-miniupnpc No UPnP support miniupnp not required
- --disable-upnp-default (the default) UPnP support turned off by default at runtime
- --enable-upnp-default UPnP support turned on by default at runtime
+Optional dependencies:
-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
+ Library | Purpose | Description
+ ------------|------------------|----------------------
+ miniupnpc | UPnP Support | Firewall-jumping support
+ libdb4.8 | Berkeley DB | Wallet storage (only needed when wallet enabled)
+ qt | GUI | GUI toolkit (only needed when GUI enabled)
+ protobuf | Payments in GUI | Data interchange format used for payment protocol (only needed when GUI enabled)
+ libqrencode | QR codes in GUI | Optional for generating QR codes (only needed when GUI enabled)
-- For the versions used in the release, see doc/release-process.md under *Fetch and build inputs*.
+For the versions used in the release, see [release-process.md](release-process.md) under *Fetch and build inputs*.
System requirements
--------------------
@@ -64,7 +58,7 @@ Dependency Build Instructions: Ubuntu & Debian
----------------------------------------------
Build requirements:
- sudo apt-get install build-essential libtool autotools-dev autoconf pkg-config libssl-dev
+ sudo apt-get install build-essential libtool autotools-dev autoconf pkg-config libssl-dev libgmp-dev
for Ubuntu 12.04 and later or Debian 7 and later libboost-all-dev has to be installed:
@@ -129,6 +123,17 @@ symbols, which reduces the executable size by about 90%.
miniupnpc
---------
+
+[miniupnpc](http://miniupnp.free.fr/) may be used for UPnP port mapping. It can be downloaded from [here](
+http://miniupnp.tuxfamily.org/files/). UPnP support is compiled in and
+turned off by default. See the configure options for upnp behavior desired:
+
+ --without-miniupnpc No UPnP support miniupnp not required
+ --disable-upnp-default (the default) UPnP support turned off by default at runtime
+ --enable-upnp-default UPnP support turned on by default at runtime
+
+To build:
+
tar -xzvf miniupnpc-1.6.tar.gz
cd miniupnpc-1.6
make