Skip to content

Commit

Permalink
doc: Port newer build documentation from Bitcoin
Browse files Browse the repository at this point in the history 
Co-authored-by: Cy Rossignol <cy@rossignols.me>

Port newer commits
  • Loading branch information
@nathanielcwm
nathanielcwm committed Nov 19, 2021
1 parent fadf99a commit ce8f1b0
Show file tree
Hide file tree
Showing 5 changed files with 302 additions and 274 deletions.
62 changes: 62 additions & 0 deletions doc/build-freebsd.md
View file
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
```
171 changes: 124 additions & 47 deletions doc/build-macos.md
View file
Original file line number Diff line number Diff line change
@@ -1,67 +1,146 @@
# macOS Build Instructions and Notes

**Updated for MacOS [11.2](https://www.apple.com/macos/big-sur/)**

This guide describes how to build gridcoinresearchd, command-line utilities, and GUI on macOS

**Note:** The following is for Intel Macs only!

## Preparation
The commands in this guide should be executed in a Terminal application.
The built-in one is located at:
macOS comes with a built-in Terminal located in:

```
/Applications/Utilities/Terminal.app
```
### 1. Xcode Command Line Tools
The Xcode Command Line Tools are a collection of build tools for macOS.
These tools must be installed in order to build Gridcoin from source.

## Preparation
Install the macOS command line tools:
To install, run the following command from your terminal:

```shell
xcode-select --install
```

When the popup appears, click `Install`.
Upon running the command, you should see a popup appear.
Click on `Install` to continue the installation process.

### 2. Homebrew Package Manager
Homebrew is a package manager for macOS that allows one to install packages from the command line easily.
While several package managers are available for macOS, this guide will focus on Homebrew as it is the most popular.
Since the examples in this guide which walk through the installation of a package will use Homebrew, it is recommended that you install it to follow along.
Otherwise, you can adapt the commands to your package manager of choice.

To install the Homebrew package manager, see: https://brew.sh

Then install [Homebrew](https://brew.sh).
Note: If you run into issues while installing Homebrew or pulling packages, refer to [Homebrew's troubleshooting page](https://docs.brew.sh/Troubleshooting).
### 3. Install Required Dependencies
The first step is to download the required dependencies.
These dependencies represent the packages required to get a barebones installation up and running.
To install, run the following from your terminal:

## Dependencies
```shell
brew install automake libtool boost miniupnpc openssl@1.1 pkg-config python qt@5 qrencode libzip
brew install automake libtool boost openssl pkg-config libzip
```

If you run into issues, check [Homebrew's troubleshooting page](https://docs.brew.sh/Troubleshooting).
### 4. Clone Gridcoin repository

If you want to build the disk image with `make deploy` (.dmg / optional), you need RSVG:
```shell
brew install librsvg
`git` should already be installed by default on your system.
Now that all the required dependencies are installed, let's clone the Gridcoin repository to a directory.
All build scripts and commands will run from this directory.

``` bash
git clone https://github.com/gridcoin-community/Gridcoin-Research
cd Gridcoin-Research
git checkout master
```

...as well as [`macdeployqtplus`](../contrib/macdeploy/README.md) dependencies:
```shell
pip3 install ds_store mac_alias
### 5. Install Optional Dependencies

#### Wallet Dependencies
Enabling wallet support requires bdb 4.8
``` bash
brew install berkeley-db@4
```

#### Berkeley DB
---

It is recommended to use Berkeley DB 4.8. If you have to build it yourself,
you can use [this](/contrib/install_db4.sh) script to install it
like so:
#### GUI Dependencies

```shell
./contrib/install_db4.sh .
###### Qt

Gridcoin includes a GUI built with the cross-platform Qt Framework.
To compile the GUI, we need to install `qt@5`.
Skip if you don't intend to use the GUI.

``` bash
brew install qt@5
```

from the root of the repository.
Ensure that the `qt@5` package is installed, not the `qt` package.
If 'qt' is installed, the build process will fail.
if installed, remove the `qt` package with the following command:

Also, the Homebrew package could be installed:
``` bash
brew uninstall qt
```

```shell
brew install berkeley-db4
Note: Building with Qt binaries downloaded from the Qt website is not officially supported.
See the notes in [Bitcoin#7714](https://github.com/bitcoin/bitcoin/issues/7714).

###### qrencode

The GUI can encode addresses in a QR Code. To build in QR support for the GUI, install `qrencode`.
Skip if not using the GUI or don't want QR code functionality.

``` bash
brew install qrencode
```
---

## Build Gridcoin
#### Port Mapping Dependencies

1. Clone the Gridcoin source code:
```shell
git clone https://github.com/gridcoin-community/Gridcoin-Research
cd Gridcoin-Research
git checkout master
```
###### miniupnpc

miniupnpc may be used for UPnP port mapping.
Skip if you do not need this functionality.

``` bash
brew install miniupnpc
```

---

#### Test Suite Dependencies

2. Build Gridcoin:
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
brew install python
```

---

#### Deploy Dependencies

You can deploy a `.dmg` containing the Gridcoin application using `make deploy`.
This command depends on a couple of python packages, so it is required that you have `python` installed.

Ensuring that `python` is installed, you can install the deploy dependencies by running the following commands in your terminal:

``` bash
brew install librsvg
```

``` bash
pip3 install ds_store mac_alias
```

## Build Gridcoin

1. Build Gridcoin:

Prepare the assembly code (requires Perl):
```shell
Expand All @@ -78,34 +157,38 @@ brew install berkeley-db4
```
You can disable the GUI build by passing `--without-gui` to configure.

3. It is recommended to build and run the unit tests:
2. It is recommended to build and run the unit tests:
```shell
make check
```

4. You can also create a `.dmg` that contains the `.app` bundle (optional):
3. You can also create a `.dmg` that contains the `.app` bundle (optional):
```shell
make deploy
```

5. Testnet participation info is found at [Using Testnet](https://wiki.gridcoin.us/OS_X_Guide#Using_Testnet).

To open the app in testnet mode:
```shell
open -a /your/path/to/gridcoinresearch.app --args -testnet
```

## Running

The daemon binary is placed in _src/_ and the GUI client is found in _src/qt/_.
For example, to run the GUI client for production or testnet:

**Important:** [Please read this before using testnet.](https://gridcoin.us/wiki/testnet)

```shell
./src/qt/gridcoinresearch
./src/qt/gridcoinresearch -testnet
./src/qt/gridcoinresearch -printtoconsole -debug -testnet
```

The first time you run Gridcoin, it will start downloading the blockchain. This process could
take several hours.

By default, blockchain and wallet data files will be stored in:

``` bash
/Users/${USER}/Library/Application Support/GridcoinResearch
```

Before running, you may create an empty configuration file:
```shell
mkdir -p "/Users/${USER}/Library/Application Support/GridcoinResearch"
Expand All @@ -115,13 +198,7 @@ touch "/Users/${USER}/Library/Application Support/GridcoinResearch/gridcoinresea
chmod 600 "/Users/${USER}/Library/Application Support/GridcoinResearch/gridcoinresearch.conf"
```

The first time you run Gridcoin, it will start downloading the blockchain. This process could
take several hours.

You can monitor the download process by looking at the debug.log file:
```shell
tail -f $HOME/Library/Application\ Support/GridcoinResearch/debug.log
```

## Notes
* Building with downloaded Qt binaries is not officially supported. See the notes in [#7714](https://github.com/bitcoin/bitcoin/issues/7714).
Loading

0 comments on commit ce8f1b0

Please sign in to comment.