Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix sentence structure #73649

Merged
merged 7 commits into from
Jul 1, 2020
Merged

Fix sentence structure #73649

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
886f81e
Fix sentence structure
Anirban166 Jun 23, 2020
3b5d7f8
Minor correction to sentence structure
Anirban166 Jun 24, 2020
d6cf8fc
Update README.md
Anirban166 Jun 24, 2020
22fc18f
Commit suggestion
Anirban166 Jun 25, 2020
8edcc6d
Add alternate text for rust logo image
Anirban166 Jun 25, 2020
3a1ac28
Added clickable-link
Anirban166 Jun 25, 2020
4c33b7c
Add responsiveness to logo
Anirban166 Jun 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# The Rust Programming Language
# The Rust Programming Language
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this change seems extraneous.

Copy link
Contributor Author

@Anirban166 Anirban166 Jun 24, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry this was a misclick on my part.
But now that I think of it, a Rust logo wouldn't be bad as an addition to that. Would you like me to create a logo for it?
or like use some badge such as this for instance?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

badge seems nice

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:D Will add that!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've replaced the h1 heading "The Rust Programming Language" with the badge which says "Rust" beside the Rust logo, with a black background wording of "Programming Language", which you can adjust it to any wording you want by replacing the word before the first dash and after it like badge/word1-word2-colour? in the link https://img.shields.io/badge/Rust-Programming%20Language-black?style=flat&logo=rust and thereafter select the color you want. (hexcodes work too I think)

I have included an image link instead of the badge notation so you can tweak with parameters such as height width etc upto your preference.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image


This is the main source code repository for [Rust]. It contains the compiler,
standard library, and documentation.
standard library and documentation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

heh, I prefer the Good Ol' Oxford comma, but I'm happy either way.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we generally do use the oxford comma

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay, won't change the oxford ways then :)


[Rust]: https://www.rust-lang.org

Expand All @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about this word "when", it sounds sort of strange to me...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, but "bootstrap building the compiler" doesn't sound quite right either, so what would you suggest in place of that?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't bother me, but I never thought that carefully about it. I'm not sure we even need the word bootstrap in there, we could just say "The rust build system uses a Python script called x.py to build the compiler." If we want to, we could add "x.py manages the bootstrapping process."

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense, will change it to that!

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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down