nimbus-eth2/docs/the_nimbus_book/src/build.md

48 lines
1.3 KiB
Markdown

# Build from source
Building Nimbus 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"
Nimbus is written in the [Nim](https://nim-lang.org) programming language.
The correct version will automatically be downloaded as part of the build process!
## Prerequisites
Make sure you have all needed [build prerequisites](./install.md#build-prerequisites).
## Building the node
### 1. Clone the `nimbus-eth2` repository
```sh
git clone https://github.com/status-im/nimbus-eth2
cd nimbus-eth2
```
### 2. Run the beacon node build process
To build the Nimbus beacon node and its dependencies, run:
```sh
make -j4 nimbus_beacon_node
```
!!! tip
Omit `-j4` on systems with 4GB of memory or less.
This step can take several minutes.
After it has finished, you can check if the installation was successful by running:
```sh
build/nimbus_beacon_node --help
```
If you see the command-line options, your installation was successful!
Otherwise, don't hesitate to reach out to us in the `#helpdesk` channel of [our discord](https://discord.gg/j3nYBUeEad).
## Keeping Nimbus updated
When you decide to upgrade Nimbus to a newer version, make sure to follow the [keeping updated guide](./keep-updated.md).