aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWladimir J. van der Laan <laanwj@gmail.com>2018-01-31 10:34:17 +0100
committerWladimir J. van der Laan <laanwj@gmail.com>2018-01-31 10:35:23 +0100
commit216f9a42e689b49a13387efff7a78d0d661b5d12 (patch)
treea142df26bb526024aa3faecf91536880dc4eb625 /doc
parentf0295becbf3ef1fb78095306408789253fe0c114 (diff)
parentee5e8968b3d86b096e8565f8ed1acf71f0528885 (diff)
downloadbitcoin-216f9a42e689b49a13387efff7a78d0d661b5d12.tar.xz
Merge #12306: Docs: Improvements to UNIX documentation
ee5e896 Organise Linux build instructions to be categorised by distro (Alex Vear) 4c85517 Add NetBSD build instruction links (Alex Vear) Pull request description: * Added references to the newly created [`doc/build-netbsd.md`] (#12294) instructions in the [`doc/README.md`] and the [`doc/build-unix.md`] files. * Organise [`doc/build-unix.md`] dependency build instructions by Linux distribution. This will help discoverability of dependency build instructions for specific distros. Future instructions will also be able to be added easier. I am not quite sure about the FreeBSD instructions being in the [`doc/build-unix.md`], while both the OpenBSD and NetBSD instructions are contained within separate files ([`doc/build-openbsd.md`] and [`doc/build-netbsd.md`] respectively). Feedback is greatly appreciated. 😄 [`doc/build-netbsd.md`]:https://github.com/bitcoin/bitcoin/blob/master/doc/build-netbsd.md [`doc/build-unix.md`]:https://github.com/bitcoin/bitcoin/blob/master/doc/build-unix.md [`doc/build-openbsd.md`]:https://github.com/bitcoin/bitcoin/blob/master/doc/build-openbsd.md [`doc/README.md`]:https://github.com/bitcoin/bitcoin/blob/master/doc/README.md Tree-SHA512: ebe2604d1802795851bbfce2335f159b53ea696bc9afb309be7825c697b992cc3963270fe945ca3e449b18522046e227fde3fae1b9c01bd49c3a7a513b5bd40c
Diffstat (limited to 'doc')
-rw-r--r--doc/README.md1
-rw-r--r--doc/build-unix.md22
2 files changed, 16 insertions, 7 deletions
diff --git a/doc/README.md b/doc/README.md
index 988019869e..ddb239f60c 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -42,6 +42,7 @@ The following are developer notes on how to build Bitcoin on your native platfor
- [Unix Build Notes](build-unix.md)
- [Windows Build Notes](build-windows.md)
- [OpenBSD Build Notes](build-openbsd.md)
+- [NetBSD Build Notes](build-netbsd.md)
- [Gitian Building Guide](gitian-building.md)
Development
diff --git a/doc/build-unix.md b/doc/build-unix.md
index af567cadeb..b823c23e0c 100644
--- a/doc/build-unix.md
+++ b/doc/build-unix.md
@@ -2,7 +2,8 @@ UNIX BUILD NOTES
====================
Some notes on how to build Bitcoin Core in Unix.
-(for OpenBSD specific instructions, see [build-openbsd.md](build-openbsd.md))
+(For BSD specific instructions, see [build-openbsd.md](build-openbsd.md) and/or
+[build-netbsd.md](build-netbsd.md))
Note
---------------------
@@ -61,8 +62,13 @@ tuned to conserve memory with additional CXXFLAGS:
./configure CXXFLAGS="--param ggc-min-expand=1 --param ggc-min-heapsize=32768"
-Dependency Build Instructions: Ubuntu & Debian
-----------------------------------------------
+
+## Linux Distribution Specific Instructions
+
+### Ubuntu & Debian
+
+#### Dependency Build Instructions
+
Build requirements:
sudo apt-get install build-essential libtool autotools-dev automake pkg-config libssl-dev libevent-dev bsdmainutils python3
@@ -104,8 +110,7 @@ ZMQ dependencies (provides ZMQ API 4.x):
sudo apt-get install libzmq3-dev
-Dependencies for the GUI: Ubuntu & Debian
------------------------------------------
+#### Dependencies for the GUI
If you want to build Bitcoin-Qt, make sure that the required packages for Qt development
are installed. Either Qt 5 or Qt 4 are necessary to build the GUI.
@@ -127,8 +132,11 @@ libqrencode (optional) can be installed with:
Once these are installed, they will be found by configure and a bitcoin-qt executable will be
built by default.
-Dependency Build Instructions: Fedora
--------------------------------------
+
+### Fedora
+
+#### Dependency Build Instructions
+
Build requirements:
sudo dnf install gcc-c++ libtool make autoconf automake openssl-devel libevent-devel boost-devel libdb4-devel libdb4-cxx-devel python3