From a8954568b3d399a158eb804b26ff20f0d20d1326 Mon Sep 17 00:00:00 2001 From: Ankit Raj Date: Wed, 24 Oct 2018 14:44:12 +0530 Subject: [PATCH 1/7] 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 7417005763..b0d5d29960 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. From 95e89eebfdd9760cd053a2c64ddabc89a66d8e8c Mon Sep 17 00:00:00 2001 From: Ankit Raj Date: Sat, 3 Nov 2018 18:49:27 +0530 Subject: [PATCH 2/7] update Updated Readme --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b0d5d29960..1aa793b9dd 100644 --- a/README.md +++ b/README.md @@ -121,9 +121,9 @@ 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. Few basic setup needed before starting like: +tests and benchmarks which may be of interest. Few basic setups 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 + 1. Install [rustup](https://rustup.rs/). It's a toolchain manager for Rust (Linux | macos | Windows). For installation run the below command in your terminal ``` $ curl https://sh.rustup.rs -sSf | sh ``` @@ -133,11 +133,11 @@ tests and benchmarks which may be of interest. Few basic setup needed before sta $ 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` . + 3. Use `rustup show` to get the info about the Rust setup. You will see active toolchain is in the stable version. + 4. Run `rustc --version` to get the version of rustup. For doing an update using` 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` + 6. 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 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 hand's dirty. In case, if there is an error, then please raise the [issue](https://github.com/sigp/lighthouse/issues). We will help you. + 7. The alternative of the above step, You can also run benchmarks by using `cargo bench --all` ##### Note: Lighthouse presently runs on Rust `stable`, however, benchmarks currently require the From b48a6109449bb43565d4e06070712e52d0b28014 Mon Sep 17 00:00:00 2001 From: Luke Anderson Date: Fri, 9 Nov 2018 10:32:25 +0530 Subject: [PATCH 3/7] Update README.md Co-Authored-By: aj07 --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1aa793b9dd..461977fb55 100644 --- a/README.md +++ b/README.md @@ -121,7 +121,9 @@ 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. Few basic setups needed before starting like: +tests and benchmarks which may be of interest. + +A few basic steps are needed to get set up: 1. Install [rustup](https://rustup.rs/). It's a toolchain manager for Rust (Linux | macos | Windows). For installation run the below command in your terminal ``` From e5c793a01a21ebd05a0e27b8c9cf2f37f1a86286 Mon Sep 17 00:00:00 2001 From: Luke Anderson Date: Sun, 25 Nov 2018 16:30:48 +0530 Subject: [PATCH 4/7] Update README.md Co-Authored-By: aj07 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 461977fb55..bf584b0066 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,7 @@ A few basic steps are needed to get set up: ``` $ curl https://sh.rustup.rs -sSf | sh ``` - 2. To configure your current shell run + 2. To configure your current shell run: ``` $ source $HOME/.cargo/env From 3d0a56a02b69873f77e2b5ffd918f97b3b4621b9 Mon Sep 17 00:00:00 2001 From: Luke Anderson Date: Sun, 25 Nov 2018 16:31:07 +0530 Subject: [PATCH 5/7] Update README.md Done Co-Authored-By: aj07 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bf584b0066..1070ad365d 100644 --- a/README.md +++ b/README.md @@ -135,7 +135,7 @@ A few basic steps are needed to get set up: $ source $HOME/.cargo/env ``` - 3. Use `rustup show` to get the info about the Rust setup. You will see active toolchain is in the stable version. + 3. Use the command `rustup show` to get information about the Rust installation. You should see that the active toolchain is the stable version. 4. Run `rustc --version` to get the version of rustup. For doing an update using` 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 test cases. If you are doing it for the first time, then you can grab a coffee 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 hand's dirty. In case, if there is an error, then please raise the [issue](https://github.com/sigp/lighthouse/issues). We will help you. From 546b341cdf41e5319e4db5e21e93f4d42471e2e8 Mon Sep 17 00:00:00 2001 From: Luke Anderson Date: Sun, 25 Nov 2018 16:31:22 +0530 Subject: [PATCH 6/7] Update README.md Done Co-Authored-By: aj07 --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1070ad365d..15fe3cd17b 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,8 @@ A few basic steps are needed to get set up: ``` 3. Use the command `rustup show` to get information about the Rust installation. You should see that the active toolchain is the stable version. - 4. Run `rustc --version` to get the version of rustup. For doing an update using` rustup update` . + 4. Run `rustc --version` to check the installation and version of rust. + - Updates can be performed using` 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 test cases. If you are doing it for the first time, then you can grab a coffee 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 hand's dirty. In case, if there is an error, then please raise the [issue](https://github.com/sigp/lighthouse/issues). We will help you. 7. The alternative of the above step, You can also run benchmarks by using `cargo bench --all` From 763badc3dc02c0a133ab880c619b5dcb5af90940 Mon Sep 17 00:00:00 2001 From: Luke Anderson Date: Sun, 25 Nov 2018 16:31:38 +0530 Subject: [PATCH 7/7] Update README.md Done Co-Authored-By: aj07 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 15fe3cd17b..c02caef7c4 100644 --- a/README.md +++ b/README.md @@ -140,7 +140,7 @@ A few basic steps are needed to get set up: - Updates can be performed using` 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 test cases. If you are doing it for the first time, then you can grab a coffee 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 hand's dirty. In case, if there is an error, then please raise the [issue](https://github.com/sigp/lighthouse/issues). We will help you. - 7. The alternative of the above step, You can also run benchmarks by using `cargo bench --all` + 7. As an alternative to, or instead of the above step, you may also run benchmarks by using the command `cargo bench --all` ##### Note: Lighthouse presently runs on Rust `stable`, however, benchmarks currently require the