-
Notifications
You must be signed in to change notification settings - Fork 173
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: Port newer build documentation from Bitcoin
Co-authored-by: Cy Rossignol <cy@rossignols.me> Link to microsoft docs for WSL install
- Loading branch information
1 parent
9b378fe
commit f171929
Showing
5 changed files
with
306 additions
and
265 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
Building on FreeBSD | ||
-------------------- | ||
|
||
**Updated for FreeBSD [12.2](https://www.freebsd.org/releases/12.2R/announce.html)** | ||
|
||
This guide describes how to build gridcoinresearchd, command-line utilities, and GUI on FreeBSD. | ||
|
||
Preparing the Build | ||
-------------------- | ||
|
||
Install the required dependencies the usual way you [install software on FreeBSD](https://www.freebsd.org/doc/en/books/handbook/ports.html) - either with `pkg` or via the Ports collection. The example commands below use `pkg` which is usually run as `root` or via `sudo`. If you want to use `sudo`, and you haven't set it up: [use this guide](http://www.freebsdwiki.net/index.php/Sudo%2C_configuring) to setup `sudo` access on FreeBSD. | ||
#### General Dependencies | ||
```bash | ||
pkg install autoconf automake boost-libs git gmake libevent libtool pkgconf db5 openssl libzip | ||
|
||
``` | ||
--- | ||
#### GUI Dependencies | ||
```bash | ||
pkg install qt5 libqrencode | ||
``` | ||
|
||
--- | ||
#### 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: | ||
|
||
```bash | ||
pkg install python3 | ||
``` | ||
|
||
Clone the repository and cd into it: | ||
|
||
``` bash | ||
git clone https://github.com/gridcoin-community/Gridcoin-Research | ||
cd Gridcoin-Research | ||
git checkout master | ||
``` | ||
|
||
To Build | ||
--------------------- | ||
### 1. Configuration | ||
|
||
There are many ways to configure Gridcoin, here are a few common examples: | ||
##### Wallet Support, No GUI: | ||
This explicitly enables wallet support and disables the GUI. | ||
```bash | ||
./autogen.sh | ||
./configure --with-gui=no --with-incompatible-bdb \ | ||
BDB_LIBS="-ldb_cxx-5" \ | ||
BDB_CFLAGS="-I/usr/local/include/db5" \ | ||
MAKE=gmake | ||
``` | ||
|
||
|
||
### 2. Compile | ||
**Important**: Use `gmake` (the non-GNU `make` will exit with an error). | ||
|
||
```bash | ||
gmake # use "-j N" for N parallel jobs | ||
gmake check # Run tests if Python 3 is available | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.