cerc-io/lighthouse
16
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Update onboarding docs to point to new docs

Browse Source
This commit is contained in:
Chris Natoli 2019-01-07 17:06:07 +11:00
parent 94a0725032
commit cfb9a1a3ae
No known key found for this signature in database
GPG Key ID: D3EA7DBA19945306
1 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/onboarding.md
View File

@ -15,6 +15,9 @@ documentation, writing extra tests or developing components, all help is
appreciated and your contributions will help not only the community but all appreciated and your contributions will help not only the community but all
the contributors. the contributors.
We've bundled up our Goals, Ethos and Ideology into one document for you to
read through, please read our [About Lighthouse](lighthouse.md) docs. :smile:
Layer-1 infrastructure is a critical component for the ecosystem and relies Layer-1 infrastructure is a critical component for the ecosystem and relies
heavily on contributions from the community. Building Ethereum Serenity is a heavily on contributions from the community. Building Ethereum Serenity is a
huge task and we refuse to conduct an inappropriate ICO or charge licensing huge task and we refuse to conduct an inappropriate ICO or charge licensing
@ -24,6 +27,20 @@ Prime.
If you have any additional questions, please feel free to jump on the If you have any additional questions, please feel free to jump on the
[gitter](https://gitter.im/sigp/lighthouse) and have a chat with all of us. [gitter](https://gitter.im/sigp/lighthouse) and have a chat with all of us.
**Pre-reading Materials:**
* [About Lighthouse](lighthouse.md)
* [Ethereum Serenity](serenity.md)
**Repository**
If you'd like to contribute, try having a look through the [open
issues](https://github.com/sigp/lighthouse/issues) (tip: look for the [good
first
issue](https://github.com/sigp/lighthouse/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
tag) and ping us on the [gitter](https://gitter.im/sigp/lighthouse) channel. We need
your support!
## Understanding Serenity ## Understanding Serenity
Ethereum's Serenity is based on a Proof-of-Stake based sharded beacon chain. Ethereum's Serenity is based on a Proof-of-Stake based sharded beacon chain.
@ -33,7 +50,7 @@ is for!* :smile:)
Read through our [Understanding Read through our [Understanding
Serenity](https://github.com/sigp/lighthouse/blob/master/docs/serenity.md) docs Serenity](https://github.com/sigp/lighthouse/blob/master/docs/serenity.md) docs
to learn more! :smile: to learn more! :smile: (*unless you've already read it.*)
The document explains the necessary fundamentals for understanding Ethereum, The document explains the necessary fundamentals for understanding Ethereum,
Proof-of-Stake and the Serenity we are working towards. Proof-of-Stake and the Serenity we are working towards.
@ -72,7 +89,7 @@ allows you to easily install versions of rust.
$ curl https://sh.rustup.rs -sSf | sh $ curl https://sh.rustup.rs -sSf | sh
``` ```
**Windows (You need a bit more):**J **Windows (You need a bit more):**
* Install the Visual Studio 2015 with C++ support * Install the Visual Studio 2015 with C++ support
* Install Rustup using: https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe * Install Rustup using: https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe
* You can then use the ``VS2015 x64 Native Tools Command Prompt`` and run: * You can then use the ``VS2015 x64 Native Tools Command Prompt`` and run: