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

Just some small gramatical improvements on READMEs

Browse Source
This commit is contained in:
Luke Anderson 2019-03-01 13:10:50 +11:00
parent 8842adb53b
commit 3753782c40
No known key found for this signature in database
GPG Key ID: 44408169EC61E228
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -33,12 +33,12 @@ If you'd like some background on Sigma Prime, please see the [Lighthouse Update
- [`beacon_node/`](beacon_node/): the "Beacon Node" binary and crates exclusively - [`beacon_node/`](beacon_node/): the "Beacon Node" binary and crates exclusively
associated with it. associated with it.
- [`docs/`](docs/): documentation related to the repository. This include contributor - [`docs/`](docs/): documentation related to the repository. This includes contributor
guides, etc. (Code documentation is produced with `cargo doc`). guides, etc. (It does not include code documentation, which can be produced with `cargo doc`).
- [`eth2/`](eth2/): Crates containing common logic across the Lighthouse project. For - [`eth2/`](eth2/): Crates containing common logic across the Lighthouse project. For
example; Ethereum 2.0 types ([`BeaconBlock`](eth2/types/src/beacon_block.rs), [`BeaconState`](eth2/types/src/beacon_state.rs), etc) and example: Ethereum 2.0 types ([`BeaconBlock`](eth2/types/src/beacon_block.rs), [`BeaconState`](eth2/types/src/beacon_state.rs), etc) and
SimpleSerialize (SSZ). SimpleSerialize (SSZ).
- [`protos/`](protos/): protobuf/gRPC definitions common across the Lighthouse project. - [`protos/`](protos/): protobuf/gRPC definitions that are common across the Lighthouse project.
- [`validator_client/`](validator_client/): the "Validator Client" binary and crates exclusively - [`validator_client/`](validator_client/): the "Validator Client" binary and crates exclusively
associated with it. associated with it.

14
eth2/README.md
View File

@ -8,19 +8,19 @@ Rust crates containing logic common across the Lighthouse project.
- [`block_proposer/`](block_proposer/): Core logic for proposing beacon blocks. - [`block_proposer/`](block_proposer/): Core logic for proposing beacon blocks.
- [`fork_choice/`](fork_choice/): A collection of fork-choice algorithms for - [`fork_choice/`](fork_choice/): A collection of fork-choice algorithms for
the Beacon Chain. the Beacon Chain.
- [`state_processing/`](state_processing/): Provides per-slot, per-block and - [`state_processing/`](state_processing/): Provides per-slot, per-block, and
per-epoch state processing. per-epoch state processing.
- [`types/`](types/): Defines base Ethereum 2.0 types (e.g., `BeaconBlock`, - [`types/`](types/): Defines base Ethereum 2.0 types (e.g., `BeaconBlock`,
`BeaconState`, etc). `BeaconState`, etc).
- [`utils/`](utils/): - [`utils/`](utils/):
- [`bls`](utils/bls/): A wrapper around an external BLS encryption library. - [`bls`](utils/bls/): A wrapper for an external BLS encryption library.
- [`boolean-bitfield`](utils/boolean-bitfield/): Provides an expandable Vec - [`boolean-bitfield`](utils/boolean-bitfield/): Provides an expandable vector
of bools, specifically for use in Eth2. of bools, specifically for use in Eth2.
- [`fisher-yates-shuffle`](utils/fisher-yates-shuffle/): shuffles a list - [`fisher-yates-shuffle`](utils/fisher-yates-shuffle/): shuffles a list
pseudo-randomly. pseudo-randomly.
- [`hashing`](utils/hashing/): A wrapper around external hashing libraries. - [`hashing`](utils/hashing/): A wrapper for external hashing libraries.
- [`honey-badger-split`](utils/honey-badger-split/): Splits a list in `n` - [`honey-badger-split`](utils/honey-badger-split/): Splits a list in `n`
parts without giving AF about the length of the list, `n` or anything parts without giving AF about the length of the list, `n`, or anything
else. else.
- [`int-to-bytes`](utils/int-to-bytes/): Simple library which converts ints - [`int-to-bytes`](utils/int-to-bytes/): Simple library which converts ints
into byte-strings of various lengths. into byte-strings of various lengths.
@ -30,8 +30,8 @@ Rust crates containing logic common across the Lighthouse project.
- [`ssz`](utils/ssz/): an implementation of the SimpleSerialize - [`ssz`](utils/ssz/): an implementation of the SimpleSerialize
serialization/deserialization protocol used by Eth 2.0. serialization/deserialization protocol used by Eth 2.0.
- [`ssz_derive`](utils/ssz_derive/): provides procedural macros for - [`ssz_derive`](utils/ssz_derive/): provides procedural macros for
deriving SSZ `Encodable`, `Decodable` and `TreeHash` methods. deriving SSZ `Encodable`, `Decodable`, and `TreeHash` methods.
- [`swap_or_not_shuffle`](utils/swap_or_not_shuffle/): a list-shuffling - [`swap_or_not_shuffle`](utils/swap_or_not_shuffle/): a list-shuffling
method which is slow, but allows for shuffling a subset of indices. method which is slow, but allows for a subset of indices to be shuffled.
- [`test_random_derive`](utils/test_random_derive/): provides procedural - [`test_random_derive`](utils/test_random_derive/): provides procedural
macros for deriving the `TestRandom` trait defined in `types`. macros for deriving the `TestRandom` trait defined in `types`.