diff --git a/source/_data/sidebar.yml b/source/_data/sidebar.yml index 64e2a29..237886b 100644 --- a/source/_data/sidebar.yml +++ b/source/_data/sidebar.yml @@ -1,9 +1,9 @@ docs: Nimbus: introduction: index.html + building: building.html milestones: milestones.html design: design.html - resources: resources.html team: team.html faq: faq.html contributor_guide: contributor_guide.html diff --git a/source/docs/building.md b/source/docs/building.md new file mode 100644 index 0000000..932081f --- /dev/null +++ b/source/docs/building.md @@ -0,0 +1,37 @@ +--- +id: building +title: 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](https://our.status.im/nimbus-for-newbies/) post. + +## Getting Started + +- [install Nim](https://bitfalls.com/nim1) +- be on a command-line friendly system (i.e. access to Terminal / Console / Git Bash / Powershell) + +## Prerequisites + +- install [RocksDB](https://rocksdb.org/) via official instructions or by running the below commands: + + - on OS X: + ```bash + brew install rocksdb + curl https://nim-lang.org/choosenim/init.sh -sSf | sh + ``` + - on Linux + ```bash + sudo apt-get install rocksdb # or your own Linux distribution's equivalent + curl https://nim-lang.org/choosenim/init.sh -sSf | sh + ``` + +## Install Nimbus + +```bash +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`. \ No newline at end of file diff --git a/themes/navy/languages/en.yml b/themes/navy/languages/en.yml index 4da9fef..0eae9b0 100644 --- a/themes/navy/languages/en.yml +++ b/themes/navy/languages/en.yml @@ -23,7 +23,8 @@ sidebar: introduction: What Is Nimbus? milestones: Milestones design: Design - ideas_for_implementation: Ideas For Implementation + faq : FAQ + building: Getting Started resources: Resources team: Team contributor_guide: Contributor Guide diff --git a/themes/navy/layout/partial/header.swig b/themes/navy/layout/partial/header.swig index 9f1b644..e223a5a 100644 --- a/themes/navy/layout/partial/header.swig +++ b/themes/navy/layout/partial/header.swig @@ -8,7 +8,7 @@