From 06a537a165150ef842457f5e92f8773e19192d4d Mon Sep 17 00:00:00 2001 From: Luke Anderson Date: Wed, 19 Jun 2019 16:12:33 +1000 Subject: [PATCH] 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