nimbus-site/source/docs/building.md

id	title
building	Getting Started with Nimbus

This document will explain how to install, test, and run Nimbus on your local machine. For a full guide, see the Nimbus for Newbies post.

Getting Started

• install Nim
• be on a command-line friendly system (i.e. access to Terminal / Console / Git Bash / Powershell)

Prerequisites

• install RocksDB via official instructions or by running the below commands:

  • on OS X:

    brew install rocksdb
    curl https://nim-lang.org/choosenim/init.sh -sSf | sh 
    

  • on Linux

    sudo apt-get install librocksdb-dev rocksdb # or your own Linux distribution's equivalent
    curl https://nim-lang.org/choosenim/init.sh -sSf | sh     
    

Install Nimbus

git clone https://github.com/status-im/nimbus
cd nimbus
nimble install
nimble test

Run Nimbus with nimbus or look at flags and options with nimbus --help.