From 86b37ff9ad69d4a0971dc4c3b82e77f6e20ddc89 Mon Sep 17 00:00:00 2001 From: James Zaki Date: Wed, 19 Jun 2019 12:56:46 +1000 Subject: [PATCH 1/3] Added Large File Storage step --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2151a0db8..acaf1bfc4 100644 --- a/README.md +++ b/README.md @@ -122,13 +122,14 @@ A few basic steps are needed to get set up: - `protobuf`: required for protobuf serialization (gRPC). - `cmake`: required for building protobuf 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. Install [Large File Support](https://git-lfs.github.com/) (required for EF tests submodule), then run `git submodule init` + 8. Run the test by using command `cargo test --all`. 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` ##### Note: From 06a537a165150ef842457f5e92f8773e19192d4d Mon Sep 17 00:00:00 2001 From: Luke Anderson Date: Wed, 19 Jun 2019 16:12:33 +1000 Subject: [PATCH 2/3] Small readme tidy. - Moved the git-lfs dep. up into the list of build dependencies - Clarified initialisation of submodules, and explicitly mentioned cloning the repo. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index acaf1bfc4..be9cb8e81 100644 --- a/README.md +++ b/README.md @@ -120,9 +120,11 @@ A few basic steps are needed to get set up: 5. Install build dependencies (Arch packages are listed here, your distribution will likely be similar): - `clang`: required by RocksDB. - `protobuf`: required for protobuf serialization (gRPC). - - `cmake`: required for building protobuf + - `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. Install [Large File Support](https://git-lfs.github.com/) (required for EF tests submodule), then run `git submodule init` + 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`. 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 From 7ff26a48dc0dabfbccd2269cd8c728fbc072a1c3 Mon Sep 17 00:00:00 2001 From: James Zaki Date: Mon, 24 Jun 2019 15:22:02 +1000 Subject: [PATCH 3/3] Edit README to test with release flag --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index be9cb8e81..8e3eb2a8c 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ A few basic steps are needed to get set up: 6. Navigate to the working directory. 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`. By running, it will pass all the required test cases. + 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.