From a8954568b3d399a158eb804b26ff20f0d20d1326 Mon Sep 17 00:00:00 2001 From: Ankit Raj Date: Wed, 24 Oct 2018 14:44:12 +0530 Subject: [PATCH] updated readme included all the details --- README.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 741700576..b0d5d2996 100644 --- a/README.md +++ b/README.md @@ -121,20 +121,25 @@ experimental. As such all cryptography is assumed to be insecure.** This code-base is still very much under-development and does not provide any user-facing functionality. For developers and researchers, there are several -tests and benchmarks which may be of interest. - -To run tests, use: +tests and benchmarks which may be of interest. Few basic setup needed before starting like: + 1. Install [rustup](https://rustup.rs/). It's a toolchain manager for Rust (Linux | macos | Windows) . For installation run the below command in your termainal + ``` + $ curl https://sh.rustup.rs -sSf | sh ``` -$ cargo test --all -``` - -To run benchmarks, use: - -``` -$ cargo bench --all + 2. To configure your current shell run + + ``` + $ source $HOME/.cargo/env ``` + + 3. Use `rustup show` to get the info about the Rust setup. You will see active toolchain is in stable version. + 4. Run `rustc --version` to get the version of rustup. For doing an update use `rustup update` . + 5. Navigate to the working directory. + 6. Run the test by using command `cargo test --all` . By running, it will pass all the required testcases. If you are doing it for first time, then you can grab a coffee meantime. Usually it takes time to build, compile and pass all test cases. If there are no error then, it means everything is working properly and it's time to get hand's dirty. In case, if there is error, then please raise the [issue](https://github.com/sigp/lighthouse/issues). We will help you. + 7. Alternative of abhove step, You can also run benchmarks by using `cargo bench --all` +##### Note: Lighthouse presently runs on Rust `stable`, however, benchmarks currently require the `nightly` version.