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

42 lines
2.0 KiB
Markdown
Raw Normal View History

[Ready] README polish (#602) * README polish * Update README.md Co-Authored-By: Jacek Sieka <jacek@status.im> * Update README.md Co-Authored-By: Jacek Sieka <jacek@status.im> * Update README.md Co-Authored-By: kdeme <kim.demey@gmail.com> * Address comments
2019-11-29 15:39:46 +00:00
# Nimbus Eth2 (Beacon Chain)
update suggestions
2020-06-19 13:14:12 +00:00
initial commit
2018-07-20 13:46:03 +00:00
[![Build Status (Travis)](https://img.shields.io/travis/status-im/nim-beacon-chain/master.svg?label=Linux%20/%20macOS "Linux/macOS build status (Travis)")](https://travis-ci.org/status-im/nim-beacon-chain)
replace the AppVeyor badge with the Azure one [skip ci]
2019-09-29 14:19:58 +00:00
[![Build Status (Azure)](https://dev.azure.com/nimbus-dev/nim-beacon-chain/_apis/build/status/status-im.nim-beacon-chain?branchName=master)](https://dev.azure.com/nimbus-dev/nim-beacon-chain/_build/latest?definitionId=3&branchName=master)
readme: update license
2018-09-05 18:46:09 +00:00
[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
initial commit
2018-07-20 13:46:03 +00:00
![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)
Update README.md
2019-10-25 11:44:32 +00:00
[![Discord: Nimbus](https://img.shields.io/badge/discord-nimbus-orange.svg)](https://discord.gg/XRxWahP)
[![Gitter: #status-im/nimbus](https://img.shields.io/badge/gitter-status--im%2Fnimbus-orange.svg)](https://gitter.im/status-im/nimbus)
fix use of legacy get.status.im domain Signed-off-by: Jakub Sokołowski <jakub@status.im>
2020-06-02 20:32:07 +00:00
[![Status: #nimbus-general](https://img.shields.io/badge/status-nimbus--general-orange.svg)](https://join.status.im/nimbus-general)
Update README.md
2019-10-25 11:44:32 +00:00
[Ready] README polish (#602) * README polish * Update README.md Co-Authored-By: Jacek Sieka <jacek@status.im> * Update README.md Co-Authored-By: Jacek Sieka <jacek@status.im> * Update README.md Co-Authored-By: kdeme <kim.demey@gmail.com> * Address comments
2019-11-29 15:39:46 +00:00
Welcome to Nimbus for Ethereum 2.0.
initial commit
2018-07-20 13:46:03 +00:00
[Ready] README polish (#602) * README polish * Update README.md Co-Authored-By: Jacek Sieka <jacek@status.im> * Update README.md Co-Authored-By: Jacek Sieka <jacek@status.im> * Update README.md Co-Authored-By: kdeme <kim.demey@gmail.com> * Address comments
2019-11-29 15:39:46 +00:00
Nimbus beacon chain is a research implementation of the beacon chain component of the upcoming Ethereum Serenity upgrade, aka Eth2.
add note to skip LFS (#383) * add note to skip LFS * Addtional note in the interop folder readme
2019-09-04 21:38:01 +00:00
update suggestions
2020-06-19 13:14:12 +00:00
## Manual
document requirements and the build process fixes #376
2019-09-04 11:14:09 +00:00
update suggestions
2020-06-19 13:14:12 +00:00
Please see the complete guide at [The nim-beacon-chain Book](https://status-im.github.io/nim-beacon-chain/).
Update README.md
2019-10-25 11:44:32 +00:00
update suggestions
2020-06-19 13:14:12 +00:00
## Quick Start
build instructions where missing make x2
2019-12-02 11:49:45 +00:00
update suggestions
2020-06-19 13:14:12 +00:00
As a user, you can connect to testnets and become a validator as follows:
document requirements and the build process fixes #376
2019-09-04 11:14:09 +00:00
```
[Ready] README polish (#602) * README polish * Update README.md Co-Authored-By: Jacek Sieka <jacek@status.im> * Update README.md Co-Authored-By: Jacek Sieka <jacek@status.im> * Update README.md Co-Authored-By: kdeme <kim.demey@gmail.com> * Address comments
2019-11-29 15:39:46 +00:00
git clone https://github.com/status-im/nim-beacon-chain
cd nim-beacon-chain
update suggestions
2020-06-19 13:14:12 +00:00
make witti
Makefile: add "publish-book" target See https://github.com/rust-lang/mdBook/blob/master/book-example/src/continuous-integration.md#deploying-to-github-pages-manually
2020-05-02 14:30:34 +00:00
```
initial commit
2018-07-20 13:46:03 +00:00
## License
Licensed and distributed under either of
readme: update license
2018-09-05 18:46:09 +00:00
update suggestions
2020-06-19 13:14:12 +00:00
- MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
readme: update license
2018-09-05 18:46:09 +00:00
Updated readme
2018-12-27 14:22:58 +00:00
or
update suggestions
2020-06-19 13:14:12 +00:00
- Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)
initial commit
2018-07-20 13:46:03 +00:00
Makefile that only works in a Git submodule (#210) - updated README.md - beacon_chain.nimble: accept compilation flags as params - nim.cfg: enable `--opt:speed` at the top level - simulation scripts: allow overriding GIT_ROOT and do some refactoring
2019-03-28 15:18:59 +00:00
at your option. These files may not be copied, modified, or distributed except according to those terms.