Added building section

This commit is contained in:
Bruno Skvorc 2018-10-10 07:21:12 +02:00
parent de49bb3a28
commit 0fff4711d0
4 changed files with 44 additions and 8 deletions

View File

@ -1,9 +1,9 @@
docs: docs:
Nimbus: Nimbus:
introduction: index.html introduction: index.html
building: building.html
milestones: milestones.html milestones: milestones.html
design: design.html design: design.html
resources: resources.html
team: team.html team: team.html
faq: faq.html faq: faq.html
contributor_guide: contributor_guide.html contributor_guide: contributor_guide.html

37
source/docs/building.md Normal file
View File

@ -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`.

View File

@ -23,7 +23,8 @@ sidebar:
introduction: What Is Nimbus? introduction: What Is Nimbus?
milestones: Milestones milestones: Milestones
design: Design design: Design
ideas_for_implementation: Ideas For Implementation faq : FAQ
building: Getting Started
resources: Resources resources: Resources
team: Team team: Team
contributor_guide: Contributor Guide contributor_guide: Contributor Guide

View File

@ -8,7 +8,7 @@
<nav> <nav>
<ul> <ul>
<li class="has-submenu"> <li class="has-submenu">
<a href="#" class="main-link">Status App</a> <a href="https://status.im" class="main-link">Status App</a>
<i class="mobile-submenu-trigger"></i> <i class="mobile-submenu-trigger"></i>
<div class="sub-menu"> <div class="sub-menu">
<ul> <ul>
@ -22,7 +22,7 @@
</div> </div>
</li> </li>
<li class="has-submenu"> <li class="has-submenu">
<a href="#" class="main-link">Embark</a> <a href="https://embark.status.im/" class="main-link">Embark</a>
<i class="mobile-submenu-trigger"></i> <i class="mobile-submenu-trigger"></i>
<div class="sub-menu"> <div class="sub-menu">
<ul> <ul>
@ -33,7 +33,6 @@
</ul> </ul>
</div> </div>
</li> </li>
<li><a href="#">Studio</a></li>
<li class="has-submenu"><a href="https://status.im/incubate">Incubate</a> <li class="has-submenu"><a href="https://status.im/incubate">Incubate</a>
<i class="mobile-submenu-trigger"></i> <i class="mobile-submenu-trigger"></i>
<div class="sub-menu"> <div class="sub-menu">
@ -68,9 +67,8 @@
<li><a href="https://status-im.github.io/people-ops.status.im/docs/working_here.html">Working Here</a></li> <li><a href="https://status-im.github.io/people-ops.status.im/docs/working_here.html">Working Here</a></li>
<li><a href="https://status-im.github.io/people-ops.status.im/docs/">Docs</a></li> <li><a href="https://status-im.github.io/people-ops.status.im/docs/">Docs</a></li>
<li><a href="https://status-im.github.io/people-ops.status.im/docs/life_status.html">Life at Status</a></li> <li><a href="https://status-im.github.io/people-ops.status.im/docs/life_status.html">Life at Status</a></li>
<li><a href="https://status.im/open-positions.html">Contribute</a></li>
<li><a href="https://status.im/open-positions.html">Jobs</a></li> <li><a href="https://status.im/open-positions.html">Jobs</a></li>
<li><a href="https://status-im.github.io/tag/people-ops">Blog</a></li> <li><a href="https://our.status.im/tag/people-ops/">Blog</a></li>
</ul> </ul>
</div> </div>
</li> </li>
@ -85,7 +83,7 @@
</div> </div>
<input type="search" id="search-input" placeholder="Search..."> <input type="search" id="search-input" placeholder="Search...">
</div> </div>
<span><a href="http://get.status.im/chat/public/status" class="button button--secondary">Status Public Chat</a></span> <span><a href="http://get.status.im/chat/public/status-nimbus" class="button button--secondary">Status Public Chat</a></span>
<span class="social-link social-link--twitter"><a href="https://twitter.com/ethstatus" target="_blank"></a></span> <span class="social-link social-link--twitter"><a href="https://twitter.com/ethstatus" target="_blank"></a></span>
<span class="social-link social-link--github"><a href="https://github.com/status-im" target="_blank"></a></span> <span class="social-link social-link--github"><a href="https://github.com/status-im" target="_blank"></a></span>
</div> </div>