Skip to content

Miscellaneous README changes - #22662

Merged
alexcrichton merged 1 commit into
rust-lang:masterfrom
iKevinY:readme-changes
Feb 23, 2015
Merged

Miscellaneous README changes#22662
alexcrichton merged 1 commit into
rust-lang:masterfrom
iKevinY:readme-changes

Conversation

@iKevinY

Copy link
Copy Markdown
Contributor
  • Various grammatical changes.
  • Use triple-backtick syntax and sh highlighting for code blocks.
  • Fix indentation of code block in step 2 of "Building on Windows".
  • Use title case for "Getting Help" subheading.

- Various grammatical changes.
- Use triple-backtick syntax and sh highlighting for code blocks.
- Fix indentation of code block in step 2 of "Building on Windows".
- Use title case for "Getting Help" subheading.
@rust-highfive

Copy link
Copy Markdown
Contributor

r? @brson

(rust_highfive has picked a reviewer for you, use r? to override)

@iKevinY

Copy link
Copy Markdown
ContributorAuthor

Also, here's a rendered version. r? @steveklabnik

Comment threadREADME.md

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

if we're using triple graves, then we shouldn't need to indent

@steveklabnik

Copy link
Copy Markdown
Contributor

r= me after a few nits, thanks!

@iKevinY

Copy link
Copy Markdown
ContributorAuthor

@steveklabnik I think the indentation is still necessary in order to keep the code blocks / blockquotes on the same "level" as the ordered lists (unless the content after the code block in step 3 of "Building From Source" should be excluded from the list). The list numberings get messed up if a top-level element appears in the middle of list (see the "Building on Windows" list on the current version of the README).

@steveklabnik

Copy link
Copy Markdown
Contributor

Ahhhhh

@steveklabnik

Copy link
Copy Markdown
Contributor

@bors: r+ 24fa6be rollup

@iKevinY

Copy link
Copy Markdown
ContributorAuthor

@steveklabnik That being said, maybe the paragraph after the note in "Building from Source" should be placed at the top level, since it's just information rather than a "step" to follow; thoughts on that change?

bombless added a commit to bombless/rust that referenced this pull request Feb 23, 2015
- Various grammatical changes.
- Use triple-backtick syntax and `sh` highlighting for code blocks.
- Fix indentation of code block in step 2 of "Building on Windows".
- Use title case for "Getting Help" subheading.
@bomblessbombless mentioned this pull request Feb 23, 2015
Manishearth added a commit to Manishearth/rust that referenced this pull request Feb 23, 2015
 - Various grammatical changes.
- Use triple-backtick syntax and `sh` highlighting for code blocks.
- Fix indentation of code block in step 2 of \"Building on Windows\".
- Use title case for \"Getting Help\" subheading.
@alexcrichton
alexcrichton merged commit 24fa6be into rust-lang:masterFeb 23, 2015
@iKevinY
iKevinY deleted the readme-changes branch February 24, 2015 04:31
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@iKevinY@rust-highfive@steveklabnik@alexcrichton@brson