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.
This commit is contained in:
parent
2b01a37ec3
commit
24fa6be7c6
1 changed files with 42 additions and 33 deletions
75
README.md
75
README.md
|
@ -15,28 +15,34 @@ Read ["Installing Rust"] from [The Book].
|
||||||
## Building from Source
|
## Building from Source
|
||||||
|
|
||||||
1. Make sure you have installed the dependencies:
|
1. Make sure you have installed the dependencies:
|
||||||
* `g++` 4.7 or `clang++` 3.x
|
|
||||||
* `python` 2.6 or later (but not 3.x)
|
* `g++` 4.7 or `clang++` 3.x
|
||||||
* GNU `make` 3.81 or later
|
* `python` 2.6 or later (but not 3.x)
|
||||||
* `curl`
|
* GNU `make` 3.81 or later
|
||||||
* `git`
|
* `curl`
|
||||||
|
* `git`
|
||||||
|
|
||||||
2. Clone the [source] with `git`:
|
2. Clone the [source] with `git`:
|
||||||
|
|
||||||
$ git clone https://github.com/rust-lang/rust.git
|
```sh
|
||||||
$ cd rust
|
$ git clone https://github.com/rust-lang/rust.git
|
||||||
|
$ cd rust
|
||||||
|
```
|
||||||
|
|
||||||
[source]: https://github.com/rust-lang/rust
|
[source]: https://github.com/rust-lang/rust
|
||||||
|
|
||||||
3. Build and install:
|
3. Build and install:
|
||||||
|
|
||||||
$ ./configure
|
```sh
|
||||||
$ make && make install
|
$ ./configure
|
||||||
|
$ make && make install
|
||||||
|
```
|
||||||
|
|
||||||
> ***Note:*** You may need to use `sudo make install` if you do not normally have
|
> ***Note:*** You may need to use `sudo make install` if you do not
|
||||||
> permission to modify the destination directory. The install locations can
|
> normally have permission to modify the destination directory. The
|
||||||
> be adjusted by passing a `--prefix` argument to `configure`. Various other
|
> install locations can be adjusted by passing a `--prefix` argument
|
||||||
> options are also supported, pass `--help` for more information on them.
|
> to `configure`. Various other options are also supported – pass
|
||||||
|
> `--help` for more information on them.
|
||||||
|
|
||||||
When complete, `make install` will place several programs into
|
When complete, `make install` will place several programs into
|
||||||
`/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
|
`/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
|
||||||
|
@ -47,27 +53,30 @@ Read ["Installing Rust"] from [The Book].
|
||||||
|
|
||||||
### Building on Windows
|
### 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.
|
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
|
2. From the MSYS2 terminal, install the `mingw64` toolchain and other required
|
||||||
# choose one based on platform
|
tools.
|
||||||
$ pacman -S mingw-w64-i686-toolchain
|
|
||||||
$ pacman -S mingw-w64-x86_64-toolchain
|
|
||||||
|
|
||||||
$ pacman -S base-devel
|
```sh
|
||||||
```
|
# Choose one based on platform:
|
||||||
|
$ pacman -S mingw-w64-i686-toolchain
|
||||||
|
$ pacman -S mingw-w64-x86_64-toolchain
|
||||||
|
|
||||||
|
$ pacman -S base-devel
|
||||||
|
```
|
||||||
|
|
||||||
3. With that now start `mingw32_shell.bat` or `mingw64_shell.bat`
|
3. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed
|
||||||
from where you installed MSYS2 (i.e. `C:\msys`). Which one you
|
MYSY2 (i.e. `C:\msys`), depending on whether you want 32-bit or 64-bit Rust.
|
||||||
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:
|
|
||||||
|
|
||||||
$ ./configure
|
4. Navigate to Rust's source code, configure and build it:
|
||||||
$ make && make install
|
|
||||||
|
```sh
|
||||||
|
$ ./configure
|
||||||
|
$ make && make install
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
|
@ -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
|
[CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
|
||||||
|
|
||||||
## Getting help
|
## Getting Help
|
||||||
|
|
||||||
The Rust community congregates in a few places:
|
The Rust community congregates in a few places:
|
||||||
|
|
||||||
* [StackOverflow] - Direct questions about using the language here.
|
* [Stack Overflow] - Direct questions about using the language.
|
||||||
* [users.rust-lang.org] - General discussion, broader questions.
|
* [users.rust-lang.org] - General discussion and broader questions.
|
||||||
* [/r/rust] - News and general discussion.
|
* [/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
|
[/r/rust]: http://reddit.com/r/rust
|
||||||
[users.rust-lang.org]: http://users.rust-lang.org/
|
[users.rust-lang.org]: http://users.rust-lang.org/
|
||||||
|
|
||||||
|
@ -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
|
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
|
variety of channels on Mozilla's IRC network, irc.mozilla.org. The
|
||||||
most popular channel is [#rust], a venue for general discussion about
|
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
|
[IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
|
||||||
[#rust]: irc://irc.mozilla.org/rust
|
[#rust]: irc://irc.mozilla.org/rust
|
||||||
|
|
Loading…
Add table
Reference in a new issue