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

Merge pull request #428 from jzaki/update-install-notes

Browse Source 
Update installation notes to include git-lfs step.
This commit is contained in:
Paul Hauner 2019-07-12 22:47:46 +10:00 committed by GitHub
commit af499c0b8c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/installation.md
View File

@ -13,14 +13,17 @@ installed):
- `clang`: required by RocksDB. - `clang`: required by RocksDB.
- `protobuf`: required for protobuf serialization (gRPC). - `protobuf`: required for protobuf serialization (gRPC).
- `cmake`: required for building protobuf - `cmake`: required for building protobuf
6. Navigate to the working directory. - `git-lfs`: The Git extension for [Large File Support](https://git-lfs.github.com/) (required for EF tests submodule).
7. Run the test by using command `cargo test --all`. By running, it will pass all the required test cases. 6. If you haven't already, clone the repository with submodules: `git clone --recursive https://github.com/sigp/lighthouse`.
Alternatively, run `git submodule init` in a repository which was cloned without submodules.
7. Change directory to the root of the repository.
8. Run the test by using command `cargo test --all --release`. By running, it will pass all the required test cases.
If you are doing it for the first time, then you can grab a coffee in the meantime. Usually, it takes time If you are doing it for the first time, then you can grab a coffee in the meantime. Usually, it takes time
to build, compile and pass all test cases. If there is no error then it means everything is working properly to build, compile and pass all test cases. If there is no error then it means everything is working properly
and it's time to get your hands dirty. and it's time to get your hands dirty.
In case, if there is an error, then please raise the [issue](https://github.com/sigp/lighthouse/issues). In case, if there is an error, then please raise the [issue](https://github.com/sigp/lighthouse/issues).
We will help you. We will help you.
8. As an alternative to, or instead of the above step, you may also run benchmarks by using 9. As an alternative to, or instead of the above step, you may also run benchmarks by using
the command `cargo bench --all` the command `cargo bench --all`
## Notes: ## Notes: