-
Notifications
You must be signed in to change notification settings - Fork 995
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Documentation to Reflect Latest Changes, Demo Instructions #599
Conversation
Codecov Report
@@ Coverage Diff @@
## master #599 +/- ##
==========================================
- Coverage 75.94% 75.82% -0.12%
==========================================
Files 47 47
Lines 3475 3475
==========================================
- Hits 2639 2635 -4
- Misses 605 608 +3
- Partials 231 232 +1
Continue to review full report at Codecov.
|
README.md
Outdated
``` | ||
|
||
### Running via Docker | ||
## Running via Docker | ||
|
||
To run the beacon node within a docker container, use the `//beacon-chain:image` target. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We actually provide two docker images for public consumption:
gcr.io/prysmaticlabs/beacon-chain:latest
gcr.io/prysmaticlabs/validator:latest
Should we update these instructions to run without bazel, using docker only?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: I haven't pushed these up yet, but I will do it when we tag the 0.0.0 release.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure thing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
one minor comment, rest looks good
README.md
Outdated
--simulator \ | ||
--verbosity debug | ||
``` | ||
Once your beacon node is up, you'll need to attach a validator client as a separate process. This validator is in charge of running Casper+Sharding responsibilities (shards to be designed in phase 2). This validator will listen for incoming beacon blocks and shard assignments and determine when its time to perform attester/proposer responsibilities accordingly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shards to be designed in phase 1 https://github.com/ethereum/wiki/wiki/Sharding-roadmap
the difference is phase 1 is data layer, phase 2 is execution layer
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if we should mention the need to delete datadir upon fresh launch?
This is the final part that resolves #485.
Description
This PR includes updates to the documentation required to run our demo as well as updates to cli flags that make it easy for people to try out the system.