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

Small readme tidy.

Browse Source 
- Moved the git-lfs dep. up into the list of build dependencies
 - Clarified initialisation of submodules, and explicitly mentioned cloning the repo.
This commit is contained in:
Luke Anderson 2019-06-19 16:12:33 +10:00
parent 86b37ff9ad
commit 06a537a165
No known key found for this signature in database
GPG Key ID: 44408169EC61E228
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -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): 5. Install build dependencies (Arch packages are listed here, your distribution will likely be similar):
- `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.
- `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. 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. 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 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