highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-11-10 05:57:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: rework dependencies.md

Browse Source
This commit is contained in:
fanquake
2021-11-19 09:52:48 +08:00
parent 310ba92494
commit 893e18059f
4 changed files with 58 additions and 128 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
doc/build-freebsd.md
View File

@@ -4,35 +4,6 @@
This guide describes how to build bitcoind, command-line utilities, and GUI on FreeBSD.
## Dependencies
The following dependencies are **required**:
Library | Purpose | Description
----------------------------------------------------------------------|------------|----------------------
[autoconf](https://svnweb.freebsd.org/ports/head/devel/autoconf/) | Build | Automatically configure software source code
[automake](https://svnweb.freebsd.org/ports/head/devel/automake/) | Build | Generate makefile (requires autoconf)
[libtool](https://svnweb.freebsd.org/ports/head/devel/libtool/) | Build | Shared library support
[pkgconf](https://svnweb.freebsd.org/ports/head/devel/pkgconf/) | Build | Configure compiler and linker flags
[git](https://svnweb.freebsd.org/ports/head/devel/git/) | Clone | Version control system
[gmake](https://svnweb.freebsd.org/ports/head/devel/gmake/) | Compile | Generate executables
[boost-libs](https://svnweb.freebsd.org/ports/head/devel/boost-libs/) | Utility | Library for threading, data structures, etc
[libevent](https://svnweb.freebsd.org/ports/head/devel/libevent/) | Networking | OS independent asynchronous networking
The following dependencies are **optional**:
Library | Purpose | Description
---------------------------------------------------------------------------|------------------|----------------------
[db5](https://svnweb.freebsd.org/ports/head/databases/db5/) | Berkeley DB | Wallet storage (only needed when wallet enabled)
[qt5](https://svnweb.freebsd.org/ports/head/devel/qt5/) | GUI | GUI toolkit (only needed when GUI enabled)
[libqrencode](https://svnweb.freebsd.org/ports/head/graphics/libqrencode/) | QR codes in GUI | Generating QR codes (only needed when GUI enabled)
[libzmq4](https://svnweb.freebsd.org/ports/head/net/libzmq4/) | ZMQ notification | Allows generating ZMQ notifications (requires ZMQ version >= 4.0.0)
[sqlite3](https://svnweb.freebsd.org/ports/head/databases/sqlite3/) | SQLite DB | Wallet storage (only needed when wallet enabled)
[python3](https://svnweb.freebsd.org/ports/head/lang/python3/) | Testing | Python Interpreter (only needed when running the test suite)
See [dependencies.md](dependencies.md) for a complete overview.
## Preparation
### 1. Install Required Dependencies
@@ -43,6 +14,8 @@ pkg install autoconf automake boost-libs git gmake libevent libtool pkgconf
```
See [dependencies.md](dependencies.md) for a complete overview.
### 2. Clone Bitcoin Repo
Now that `git` and all the required dependencies are installed, let's clone the Bitcoin Core repository to a directory. All build scripts and commands will run from this directory.
``` bash
@@ -84,6 +57,14 @@ pkg install libqrencode
```
---
#### Notifications
###### ZeroMQ
Bitcoin Core can provide notifications via ZeroMQ. If the package is installed, support will be compiled in.
```bash
pkg install libzmq4
```
#### Test Suite Dependencies
There is an included test suite that is useful for testing code changes when developing.
To run the test suite (recommended), you will need to have Python 3 installed: