From 886f81e1d0883f67fbc81b8ece61b1c33f6923d2 Mon Sep 17 00:00:00 2001 From: Anirban Date: Tue, 23 Jun 2020 16:11:13 +0530 Subject: [PATCH 1/7] Fix sentence structure Fixed grammar and sentence structure on appropriate instances. --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 42fc0a63c0ffb..e9273cb6db8d9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# The Rust Programming Language +# The Rust Programming Language This is the main source code repository for [Rust]. It contains the compiler, -standard library, and documentation. +standard library and documentation. [Rust]: https://www.rust-lang.org @@ -17,8 +17,8 @@ Read ["Installation"] from [The Book]. _Note: If you wish to contribute to the compiler, you should read [this chapter][rustcguidebuild] of the rustc-dev-guide instead of this section._ -The Rust build system has a Python script called `x.py` to bootstrap building -the compiler. More information about it may be found by running `./x.py --help` +The Rust build system has a Python script called `x.py` to bootstrap when building +the compiler. More information about it can be found by running `./x.py --help` or reading the [rustc dev guide][rustcguidebuild]. [rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html @@ -54,9 +54,9 @@ or reading the [rustc dev guide][rustcguidebuild]. $ cp config.toml.example config.toml ``` - It is recommended that if you plan to use the Rust build system to create - an installation (using `./x.py install`) that you set the `prefix` value - in the `[install]` section to a directory that you have write permissions. + It is recommended that you set the `prefix` value in the `[install]` + section to a directory that you have write permissions if you plan to use + the Rust build system to create an installation. (using `./x.py install`) Create install directory if you are not installing in default directory @@ -143,8 +143,8 @@ shell with: ``` Currently, building Rust only works with some known versions of Visual Studio. If -you have a more recent version installed the build system doesn't understand -then you may need to force rustbuild to use an older version. This can be done +you have a more recent version installed and the build system doesn't understand, +you may need to force rustbuild to use an older version. This can be done by manually calling the appropriate vcvars file before running the bootstrap. ```batch From 3b5d7f8cf66c6704d36b021f7173241d6351ad32 Mon Sep 17 00:00:00 2001 From: Anirban Date: Wed, 24 Jun 2020 10:29:35 +0530 Subject: [PATCH 2/7] Minor correction to sentence structure --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e9273cb6db8d9..6258356fd4672 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # The Rust Programming Language This is the main source code repository for [Rust]. It contains the compiler, -standard library and documentation. +standard library, and documentation. [Rust]: https://www.rust-lang.org @@ -54,9 +54,8 @@ or reading the [rustc dev guide][rustcguidebuild]. $ cp config.toml.example config.toml ``` - It is recommended that you set the `prefix` value in the `[install]` - section to a directory that you have write permissions if you plan to use - the Rust build system to create an installation. (using `./x.py install`) + If you plan to use `x.py install` to create an installation, it is recommended + that you set the `prefix` value in the `[install]` section to a directory. Create install directory if you are not installing in default directory From d6cf8fc63ee24269bd4df20ad9fe19a219b5c9f5 Mon Sep 17 00:00:00 2001 From: Anirban Date: Wed, 24 Jun 2020 21:09:08 +0530 Subject: [PATCH 3/7] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6258356fd4672..f423d7527cc59 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# The Rust Programming Language + This is the main source code repository for [Rust]. It contains the compiler, standard library, and documentation. @@ -17,9 +17,9 @@ Read ["Installation"] from [The Book]. _Note: If you wish to contribute to the compiler, you should read [this chapter][rustcguidebuild] of the rustc-dev-guide instead of this section._ -The Rust build system has a Python script called `x.py` to bootstrap when building -the compiler. More information about it can be found by running `./x.py --help` -or reading the [rustc dev guide][rustcguidebuild]. +The Rust build system uses a Python script called x.py to build the compiler, +which manages the bootstrapping process. More information about it can be found +by running `./x.py --help` or reading the [rustc dev guide][rustcguidebuild]. [rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html From 22fc18f1776ab05688d2f57ed92e14830a44d1ee Mon Sep 17 00:00:00 2001 From: Anirban Date: Thu, 25 Jun 2020 16:29:37 +0530 Subject: [PATCH 4/7] Commit suggestion Co-authored-by: Niko Matsakis --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f423d7527cc59..18fb19b85afaf 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Read ["Installation"] from [The Book]. _Note: If you wish to contribute to the compiler, you should read [this chapter][rustcguidebuild] of the rustc-dev-guide instead of this section._ -The Rust build system uses a Python script called x.py to build the compiler, +The Rust build system uses a Python script called `x.py` to build the compiler, which manages the bootstrapping process. More information about it can be found by running `./x.py --help` or reading the [rustc dev guide][rustcguidebuild]. From 8edcc6d00d329c4cbe51b483bb82a1b365a073b4 Mon Sep 17 00:00:00 2001 From: Anirban Date: Thu, 25 Jun 2020 16:32:54 +0530 Subject: [PATCH 5/7] Add alternate text for rust logo image --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 18fb19b85afaf..cad82f9c72ec9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - +The Rust Programming Language This is the main source code repository for [Rust]. It contains the compiler, standard library, and documentation. From 3a1ac2823167e6254066758a7487ad384d32d7da Mon Sep 17 00:00:00 2001 From: Anirban Date: Thu, 25 Jun 2020 16:43:27 +0530 Subject: [PATCH 6/7] Added clickable-link Linked the logo/svg to https://www.rust-lang.org/ (change if required) --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index cad82f9c72ec9..58b10f4e19b92 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ + The Rust Programming Language + This is the main source code repository for [Rust]. It contains the compiler, standard library, and documentation. From 4c33b7c8d69648edcc7f4f3d2edbf96c00060d1e Mon Sep 17 00:00:00 2001 From: Anirban Date: Thu, 25 Jun 2020 19:33:19 +0530 Subject: [PATCH 7/7] Add responsiveness to logo Added responsiveness to image logo based on device width (set at 90% of device width, which can be changed as per requirement) --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 58b10f4e19b92..c2ded10f05a36 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ - -The Rust Programming Language + +The Rust Programming Language This is the main source code repository for [Rust]. It contains the compiler,