mirror of https://github.com/status-im/nimbus-eth1.git synced 2025-02-22 00:38:25 +00:00

Add more documentation to the fluffy book and reorganize it (#1856 )

Moved pretty much everything from the readme.md file now to the
book and structured it better to be more accessible.

2023-10-24 18:18:30 +02:00

1.2 KiB

Raw Blame History

Build from source

Building Fluffy from source ensures that all hardware-specific optimizations are turned on. The build process itself is simple and fully automated, but may take a few minutes.

!!! note "Nim" Fluffy is written in the Nim programming language. The correct version will automatically be downloaded as part of the build process!

Prerequisites

Make sure you have all needed prerequisites.

Building the Fluffy client

1. Clone the `nimbus-eth1` repository

git clone git@github.com:status-im/nimbus-eth1.git
cd nimbus-eth1

2. Run the Fluffy build process

To build Fluffy and its dependencies, run:

make fluffy

This step can take several minutes. After it has finished, you can check if the build was successful by running:

# See available command line options
./build/fluffy --help

If you see the command-line options, your installation was successful! Otherwise, don't hesitate to reach out to us in the #nimbus-fluffy channel of our discord.

Keeping Fluffy updated

When you decide to upgrade Fluffy to a newer version, make sure to follow the how to upgrade page.

1.2 KiB Raw Blame History