Update instructions with Windows

This commit is contained in:
Bruno Skvorc 2019-04-27 22:28:52 +02:00
parent 87d9a1ac59
commit a0be63357f
3 changed files with 23 additions and 6 deletions

View File

@ -7,14 +7,19 @@ This document will explain how to install, test, and run Nimbus on your local ma
## Installing prerequisites ## Installing prerequisites
_Right now, Nimbus is only available on non-Windows operating systems. We're working on Windows support. If you don't have a Linux or OS X machine, please consider using our [pre-configured Vagrant box](https://github.com/status-im/nim-vagrant)._ If you are on Windows, instead of using the commands below you can also use our [pre-configured Vagrant box](https://github.com/status-im/nim-vagrant) if you prefer to run things in a Linux environment.
We use Makefiles to quickly and easily build our binaries. Before you begin, please make sure you have [RocksDB installed](https://github.com/status-im/nimbus#rocksdb). Then, run: We use Makefiles to quickly and easily build our binaries. Before you begin, please make sure you have [RocksDB installed](https://github.com/status-im/nimbus#rocksdb). On Windows, you can skip this step and instead rely on the "WINDOWS ONLY" part of the process below:
```bash ```bash
git clone https://github.com/status-im/nimbus git clone https://github.com/status-im/nimbus
cd nimbus cd nimbus
make update deps # Downloads and builds submodules, dependencies, and even Nim itself make update # Downloads and builds submodules, dependencies, and even Nim itself
# >>> WINDOWS ONLY <<<
make fetch-dlls # WINDOWS ONLY
# >>> WINDOWS ONLY <<<
./env.sh bash # Optional, but useful. Sets the current shell's environment to use the version of Nim language the `make update deps` command just built ./env.sh bash # Optional, but useful. Sets the current shell's environment to use the version of Nim language the `make update deps` command just built
``` ```
@ -82,7 +87,7 @@ Use the output of the help command to pass desired values to the sim - change nu
### Nimbus Ethereum 2.0 Testnet ### Nimbus Ethereum 2.0 Testnet
We have a publicly available testnet running between Nimbus nodes. Read all about it and learn how you can join it [here](https://our.status.im/the-nimbus-mvp-testnet-is-here/). We have a publicly available testnet running between Nimbus nodes. Read all about it and learn how you can join it [here](/docs/t0.html).
--- ---

View File

@ -7,13 +7,20 @@ This document is a very short guide on how to join our testnet. For a full expla
## Joining Nimbus Testnet 0 ## Joining Nimbus Testnet 0
Here is the full process if you're starting from scratch, without even Nim installed (you still need RocksDB though, so [install that first](https://github.com/status-im/nimbus#rocksdb)): _Note: in the below commands, the command `make` is universal to *nix systems like Linux / OS X. On Windows, it becomes available with [Git Bash](https://git-scm.com/download/win) if you install Git for Windows, but you can also install [MinGW64](https://github.com/status-im/nimbus#windows) (recommended)._
Here is the full process if you're starting from scratch, without even Nim installed (you still need RocksDB though, so [install that first](https://github.com/status-im/nimbus#rocksdb)), unless you're on Windows, in which case the "WINDOWS ONLY" part below will handle the problem for you:
```bash ```bash
# Ensure you have rocksdb installed before running this! # Ensure you have rocksdb installed before running this!
git clone https://github.com/status-im/nimbus git clone https://github.com/status-im/nimbus
cd nimbus cd nimbus
make update # this might take a few minutes make update # this might take a few minutes
# >>> WINDOWS ONLY <<<
make fetch-dlls # WINDOWS ONLY
# >>> WINDOWS ONLY <<<
cd vendor/nim-beacon-chain # All Ethereum 2.0 functionality is in here cd vendor/nim-beacon-chain # All Ethereum 2.0 functionality is in here
make testnet0 make testnet0
./build/testnet0_node # this launches the testnet0-specific node you just built ./build/testnet0_node # this launches the testnet0-specific node you just built
@ -24,6 +31,11 @@ Here is the full process if you've already run testnet0 before but might be stuc
```bash ```bash
cd nimbus cd nimbus
make update # update dependencies make update # update dependencies
# >>> WINDOWS ONLY <<<
make fetch-dlls # WINDOWS ONLY
# >>> WINDOWS ONLY <<<
cd vendor/nim-beacon-chain cd vendor/nim-beacon-chain
make clean-testnet0 testnet0 # clean cache and rebuild binary make clean-testnet0 testnet0 # clean cache and rebuild binary
./build/testnet0_node # this launches the testnet0-specific node you just built ./build/testnet0_node # this launches the testnet0-specific node you just built