status-im
/
nimbus-eth2
mirror of https://github.com/status-im/nimbus-eth2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

update doc links

This commit is contained in:
Jacek Sieka 2021-03-10 09:47:31 +01:00
parent 82c300186b
commit 74a75d05a0
No known key found for this signature in database
GPG Key ID: A1B09461ABB656B8
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -33,9 +33,9 @@ Nimbus beacon chain is a research implementation of the beacon chain component o
## Documentation
You can find the information you need to run a beacon node and operate as a validator in [The Book](https://status-im.github.io/nimbus-eth2/).
You can find the information you need to run a beacon node and operate as a validator in [The Book](https://nimbus.guide/).
The [Quickstart](https://status-im.github.io/nimbus-eth2/quick-start.html) in particular will help you get connected to the Pyrmont Testnet and eth2 Mainnet quickly!
The [Quickstart](https://nimbus.guide/quick-start.html) in particular will help you get connected to the Pyrmont Testnet and eth2 Mainnet quickly!
## Related projects
@ -52,11 +52,11 @@ You can check where the beacon chain fits in the Ethereum ecosystem our Two-Poin
## Developer resources
To build tools that interact with Nimbus while it's running, we expose an [RPC API](https://status-im.github.io/nimbus-eth2/api.html).
To build tools that interact with Nimbus while it's running, we expose an [RPC API](https://nimbus.guide/api.html).
To get started with developing Nimbus itself, see the [developer handbook](https://status-im.github.io/nimbus-eth2/developers.html).
To get started with developing Nimbus itself, see the [developer handbook](https://nimbus.guide/developers.html). The code follows the [Status Nim Style Guide](https://status-im.github.io/nim-style-guide/).
Nimbus is built in the [Nim language](https://nim-lang.org) - the compiler is automatically installed when building the project for the first time. More information - in particular security-related information about the language - can be found in the [Auditor Handbook](https://status-im.github.io/nimbus-eth2/auditors-book/).
Nimbus is built in the [Nim language](https://nim-lang.org) - the compiler is automatically installed when building the project for the first time. More information - in particular security-related information about the language - can be found in the [Auditor Handbook](https://nimbus.guide/auditors-book/).
## Interop tooling

6
docs/the_nimbus_book/src/developers.md
View File

@ -4,6 +4,10 @@ This page contains tips and tricks for developers, further resources, along with
Before building Nimbus for the first time, make sure to install the [prerequisites](./install.md).
## Code style
The code follows the [Status Nim Style Guide](https://status-im.github.io/nim-style-guide/).
## Branch lifecycle
The git repository has 3 main branches, `stable`, `testing` and `unstable` as well as feature and bugfix branches.
@ -174,7 +178,7 @@ The specified value is a percentage of a single CPU core. Usually 1 - 100, but c
## Build and run the local beacon chain simulation
The beacon chain simulation runs several beacon nodes on the local machine, attaches several local validators to each, and builds a beacon chain between them.
The beacon chain simulation runs several beacon nodes on the local machine, attaches several local validators to each, and builds a beacon chain between them.
To run the simulation: