Skip to content

Rollup of 20 pull requests #22703

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.

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

Closed
wants to merge 48 commits into from
Closed
Changes from 1 commit
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
ef1308c
Handle RUST_TEST_NOCAPTURE in compiletest and set add if to run env
fhahn Feb 15, 2015
2b7f7f2
Replace `exchange_malloc`/`exchange_free` demo with something unrelat…
pnkfelix Feb 17, 2015
55f625a
os.getcwd renamed to env::current_dir
tshepang Feb 18, 2015
2f735f5
unused imports
tshepang Feb 18, 2015
ac3a390
rustbook: no-longer-used feature gate
tshepang Feb 18, 2015
bb22c10
borrowck/README.md: Remove most references to &const
kmcallister Feb 19, 2015
0c1fc1c
borrowck/README.md: Clarify MUTABILITY and ALIASABLE
kmcallister Feb 19, 2015
160cf96
borrowck/README.md: Remove SCOPE (mostly unused)
kmcallister Feb 19, 2015
ac6cab0
borrowck/README.md: Fix display of code on GitHub
kmcallister Feb 19, 2015
f051e13
Fix references to doc.rs throughout the code
kmcallister Feb 19, 2015
1597f91
borrowck/README.md: Normalize types in examples
kmcallister Feb 19, 2015
96be553
book: Minor clarifications about strings
brson Feb 20, 2015
fcc21b3
docs: Explain static dispatch advantage more clearly
brson Feb 20, 2015
eceab29
Fix typo
bombless Feb 20, 2015
b4dc9fd
Remove last traces of BitV and BitVSet from documentation
fhartwig Feb 21, 2015
aa6604a
Fix small typo in reference to code of conduct
tigarmo Feb 22, 2015
c2a2b10
shift int/uint tests around to avoid code repetition
glacjay Feb 22, 2015
928341e
Include tuple indexing in the Reference.
achernya Feb 22, 2015
24fa6be
Miscellaneous README changes
iKevinY Feb 21, 2015
c5a3cbb
Fix typos in CStr docs
shepmaster Feb 22, 2015
a499148
Fix another occurrence of #22243
untitaker Feb 22, 2015
d7c02c3
Link from literals to their representation
steveklabnik Feb 13, 2015
27f3571
Improve documentation for libcollections/str
steveklabnik Feb 18, 2015
6f9b91d
save-analysis: handle type defs in struct patterns
nrc Feb 19, 2015
6154c88
Update intro.md to fix thread spawning example Closes #22419
diamondman Feb 13, 2015
04b0a3a
save-analysis: fix impls on primitive types
nrc Feb 22, 2015
72eaf2c
Switch to &vector notation in the iterators chapter.
jxcl Feb 21, 2015
9f2b067
Fixed erroneous statements in iterators.md.
jxcl Feb 23, 2015
f71ca70
Rollup merge of #22270 - steveklabnik:gh22152, r=huonw
bombless Feb 23, 2015
fb17900
Rollup merge of #22371 - fhahn:issue-17829-compiletest-nocapture, r=M…
bombless Feb 23, 2015
bf2c75a
Rollup merge of #22499 - pnkfelix:purge-demo-of-exchange-malloc-and-f…
bombless Feb 23, 2015
198db70
Rollup merge of #22505 - tshepang:current_dir, r=steveklabnik
bombless Feb 23, 2015
4384418
Rollup merge of #22513 - steveklabnik:doc_str, r=brson
bombless Feb 23, 2015
93b6541
Rollup merge of #22514 - diamondman:intro_doc_threading, r=steveklabnik
bombless Feb 23, 2015
53e8232
Rollup merge of #22556 - brson:str, r=steveklabnik
bombless Feb 23, 2015
5c4e0c6
Rollup merge of #22559 - kmcallister:borrowck-readme, r=nikomatsakis
bombless Feb 23, 2015
8febe56
Rollup merge of #22593 - brson:spatch, r=steveklabnik
bombless Feb 23, 2015
310833c
Rollup merge of #22601 - bombless:patch-1, r=Manishearth
bombless Feb 23, 2015
cac3007
Rollup merge of #22612 - jxcl:iter-replace, r=steveklabnik
bombless Feb 23, 2015
2ae7e29
Rollup merge of #22613 - nick29581:fix-save-alias, r=huonw
bombless Feb 23, 2015
030b188
Rollup merge of #22643 - fhartwig:bitvec-doc-fix, r=alexcrichton
bombless Feb 23, 2015
f8dc117
Rollup merge of #22652 - tigarmo:patch-1, r=Manishearth
bombless Feb 23, 2015
375c75c
Rollup merge of #22658 - glacjay:issue-22535, r=Gankro
bombless Feb 23, 2015
8d1753b
Rollup merge of #22660 - achernya:tuple-reference, r=alexcrichton
bombless Feb 23, 2015
54b80ec
Rollup merge of #22662 - iKevinY:readme-changes, r=steveklabnik
bombless Feb 23, 2015
9135cb0
Rollup merge of #22670 - shepmaster:c_str_typos, r=Manishearth
bombless Feb 23, 2015
b8cfe57
Rollup merge of #22674 - untitaker:issue22243, r=alexcrichton
bombless Feb 23, 2015
cf05774
Rollup merge of #22691 - nick29581:fix-save-impl, r=huonw
bombless Feb 23, 2015
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
Prev Previous commit
Next Next commit
Miscellaneous README changes
- 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.
  • Loading branch information
iKevinY committed Feb 22, 2015
commit 24fa6be7c66f9d2eaa18cb512e01a818201a6aae
75 changes: 42 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,28 +15,34 @@ Read ["Installing Rust"] from [The Book].
## Building from Source

1. Make sure you have installed the dependencies:
* `g++` 4.7 or `clang++` 3.x
* `python` 2.6 or later (but not 3.x)
* GNU `make` 3.81 or later
* `curl`
* `git`

* `g++` 4.7 or `clang++` 3.x
* `python` 2.6 or later (but not 3.x)
* GNU `make` 3.81 or later
* `curl`
* `git`

2. Clone the [source] with `git`:

$ git clone https://github.com/rust-lang/rust.git
$ cd rust
```sh
$ git clone https://github.com/rust-lang/rust.git
$ cd rust
```

[source]: https://github.com/rust-lang/rust

3. Build and install:

$ ./configure
$ make && make install
```sh
$ ./configure
$ make && make install
```

> ***Note:*** You may need to use `sudo make install` if you do not normally have
> permission to modify the destination directory. The install locations can
> be adjusted by passing a `--prefix` argument to `configure`. Various other
> options are also supported, pass `--help` for more information on them.
> ***Note:*** You may need to use `sudo make install` if you do not
> normally have permission to modify the destination directory. The
> install locations can be adjusted by passing a `--prefix` argument
> to `configure`. Various other options are also supported – pass
> `--help` for more information on them.

When complete, `make install` will place several programs into
`/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
Expand All @@ -47,27 +53,30 @@ Read ["Installing Rust"] from [The Book].

### Building on Windows

To easily build on windows we can use [MSYS2](http://msys2.github.io/):
[MSYS2](http://msys2.github.io/) can be used to easily build Rust on Windows:

1. Grab the latest MSYS2 installer and go through the installer.
2. Now from the MSYS2 terminal we want to install the mingw64 toolchain and the other
tools we need.

```bash
# choose one based on platform
$ pacman -S mingw-w64-i686-toolchain
$ pacman -S mingw-w64-x86_64-toolchain
2. From the MSYS2 terminal, install the `mingw64` toolchain and other required
tools.

```sh
# Choose one based on platform:
$ pacman -S mingw-w64-i686-toolchain
$ pacman -S mingw-w64-x86_64-toolchain

$ pacman -S base-devel
```

$ pacman -S base-devel
```
3. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
MYSY2 (i.e. `C:\msys`), depending on whether you want 32-bit or 64-bit Rust.

3. With that now start `mingw32_shell.bat` or `mingw64_shell.bat`
from where you installed MSYS2 (i.e. `C:\msys`). Which one you
choose depends on if you want 32 or 64 bit Rust.
4. From there just navigate to where you have Rust's source code, configure and build it:
4. Navigate to Rust's source code, configure and build it:

$ ./configure
$ make && make install
```sh
$ ./configure
$ make && make install
```

## Notes

Expand All @@ -92,15 +101,15 @@ There is more advice about hacking on Rust in [CONTRIBUTING.md].

[CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md

## Getting help
## Getting Help

The Rust community congregates in a few places:

* [StackOverflow] - Direct questions about using the language here.
* [users.rust-lang.org] - General discussion, broader questions.
* [Stack Overflow] - Direct questions about using the language.
* [users.rust-lang.org] - General discussion and broader questions.
* [/r/rust] - News and general discussion.

[StackOverflow]: http://stackoverflow.com/questions/tagged/rust
[Stack Overflow]: http://stackoverflow.com/questions/tagged/rust
[/r/rust]: http://reddit.com/r/rust
[users.rust-lang.org]: http://users.rust-lang.org/

Expand All @@ -111,7 +120,7 @@ To contribute to Rust, please see [CONTRIBUTING.md](CONTRIBUTING.md).
Rust has an [IRC] culture and most real-time collaboration happens in a
variety of channels on Mozilla's IRC network, irc.mozilla.org. The
most popular channel is [#rust], a venue for general discussion about
Rust, and a good place to ask for help,
Rust, and a good place to ask for help.

[IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
[#rust]: irc://irc.mozilla.org/rust
Expand Down