From efcbb1649140d73c771b2846fb38b7ce68d62d99 Mon Sep 17 00:00:00 2001 From: jzaki Date: Tue, 9 Jul 2019 14:52:05 +1000 Subject: [PATCH] Update installation notes to include git-lfs step. --- docs/installation.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 135304890..9c317fab9 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -13,14 +13,17 @@ installed): - `clang`: required by RocksDB. - `protobuf`: required for protobuf serialization (gRPC). - `cmake`: required for building protobuf + - `git-lfs`: The Git extension for [Large File Support](https://git-lfs.github.com/) (required for EF tests submodule). 6. Navigate to the working directory. - 7. Run the test by using command `cargo test --all`. By running, it will pass all the required test cases. + 7. 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. + 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 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. In case, if there is an error, then please raise the [issue](https://github.com/sigp/lighthouse/issues). 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` ## Notes: