mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2c75256c15
rust/src/doc/trpl/installing-rust.md

102 lines
3.9 KiB
Markdown
Raw Normal View History

Fix dead links in the guide and reorganize
2015-01-08 12:27:03 -06:00
% Installing Rust
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section.
2014-12-02 08:20:48 -06:00
The first step to using Rust is to install it! There are a number of ways to
More editing work on TRPL Fill out blank section headers. Copy edit the entire first section.
2015-04-09 14:17:31 -05:00
install Rust, but the easiest is to use the `rustup` script. If you're on Linux
Make note about $ more prominent. Fixes #25554
2015-05-29 11:20:32 -05:00
or a Mac, all you need to do is this:
> Note: you don't need to type in the `$`s, they just indicate the start of
> each command. You’ll see many tutorials and examples around the web that
> follow this convention: `$` for commands run as your regular user, and
> `#` for commands you should be running as an administrator.
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section.
2014-12-02 08:20:48 -06:00
```bash
doc: rustup.sh doesn't require sudo
2015-04-30 18:17:42 -05:00
$ curl -sf -L https://static.rust-lang.org/rustup.sh | sh
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section.
2014-12-02 08:20:48 -06:00
```
More editing work on TRPL Fill out blank section headers. Copy edit the entire first section.
2015-04-09 14:17:31 -05:00
If you're concerned about the [potential insecurity][insecurity] of using `curl
doc: rustup.sh doesn't require sudo
2015-04-30 18:17:42 -05:00
| sh`, please keep reading and see our disclaimer below. And feel free to
More editing work on TRPL Fill out blank section headers. Copy edit the entire first section.
2015-04-09 14:17:31 -05:00
use a two-step version of the installation and examine our installation script:
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section.
2014-12-02 08:20:48 -06:00
```bash
Add the -s flag to the suggested rustup invocation curl's progress meter would otherwise interfere with sudo's password prompt. In addition, add the -f flag to make sure 4xx status codes are treated as errors.
2015-03-13 03:31:50 -05:00
$ curl -f -L https://static.rust-lang.org/rustup.sh -O
doc: rustup.sh doesn't require sudo
2015-04-30 18:17:42 -05:00
$ sh rustup.sh
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section.
2014-12-02 08:20:48 -06:00
```
More editing work on TRPL Fill out blank section headers. Copy edit the entire first section.
2015-04-09 14:17:31 -05:00
[insecurity]: http://curlpipesh.tumblr.com
If you're on Windows, please download either the [32-bit installer][win32] or
the [64-bit installer][win64] and run it.
Update windows install links to 1.0 Fixes #25489
2015-05-16 12:18:52 -05:00
[win32]: https://static.rust-lang.org/dist/rust-1.0.0-i686-pc-windows-gnu.msi
[win64]: https://static.rust-lang.org/dist/rust-1.0.0-x86_64-pc-windows-gnu.msi
More editing work on TRPL Fill out blank section headers. Copy edit the entire first section.
2015-04-09 14:17:31 -05:00
## Uninstalling
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section.
2014-12-02 08:20:48 -06:00
If you decide you don't want Rust anymore, we'll be a bit sad, but that's okay.
Update uninstall instructions
2015-02-12 21:19:35 -06:00
Not every programming language is great for everyone. Just run the uninstall
script:
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section.
2014-12-02 08:20:48 -06:00
```bash
Update uninstall instructions
2015-02-12 21:19:35 -06:00
$ sudo /usr/local/lib/rustlib/uninstall.sh
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section.
2014-12-02 08:20:48 -06:00
```
More editing work on TRPL Fill out blank section headers. Copy edit the entire first section.
2015-04-09 14:17:31 -05:00
If you used the Windows installer, just re-run the `.msi` and it will give you
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section.
2014-12-02 08:20:48 -06:00
an uninstall option.
More editing work on TRPL Fill out blank section headers. Copy edit the entire first section.
2015-04-09 14:17:31 -05:00
Some people, and somewhat rightfully so, get very upset when we tell you to
doc: rustup.sh doesn't require sudo
2015-04-30 18:17:42 -05:00
`curl | sh`. Basically, when you do this, you are trusting that the good
More editing work on TRPL Fill out blank section headers. Copy edit the entire first section.
2015-04-09 14:17:31 -05:00
people who maintain Rust aren't going to hack your computer and do bad things.
That's a good instinct! If you're one of those people, please check out the
TRPL: Clean up some Markdown links In all other places the IDs of link references are without spaces (and explicitly set).
2015-05-25 08:10:50 -05:00
documentation on [building Rust from Source][from-source], or [the official
binary downloads][install-page].
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section.
2014-12-02 08:20:48 -06:00
TRPL: Clean up some Markdown links In all other places the IDs of link references are without spaces (and explicitly set).
2015-05-25 08:10:50 -05:00
[from-source]: https://github.com/rust-lang/rust#building-from-source
[install-page]: http://www.rust-lang.org/install.html
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section.
2014-12-02 08:20:48 -06:00
Oh, we should also mention the officially supported platforms:
* Windows (7, 8, Server 2008 R2)
* Linux (2.6.18 or later, various distributions), x86 and x86-64
* OSX 10.7 (Lion) or greater, x86 and x86-64
We extensively test Rust on these platforms, and a few others, too, like
Android. But these are the ones most likely to work, as they have the most
testing.
Finally, a comment about Windows. Rust considers Windows to be a first-class
platform upon release, but if we're honest, the Windows experience isn't as
integrated as the Linux/OS X experience is. We're working on it! If anything
does not work, it is a bug. Please let us know if that happens. Each and every
commit is tested against Windows just like any other platform.
If you've got Rust installed, you can open up a shell, and type this:
```bash
$ rustc --version
```
Update expected output of `rustc --version` The format of `rustc --version` was changed in #21957.
2015-02-27 05:13:05 -06:00
You should see the version number, commit hash, commit date and build date:
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section.
2014-12-02 08:20:48 -06:00
```bash
Update the shown installed rust version to 1.0 :tada: :tada: :tada:
2015-05-16 10:20:07 -05:00
rustc 1.0.0 (a59de37e9 2015-05-13) (built 2015-05-14)
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section.
2014-12-02 08:20:48 -06:00
```
If you did, Rust has been installed successfully! Congrats!
Add note about local documentation installation Fixes #23244
2015-03-11 12:45:55 -05:00
This installer also installs a copy of the documentation locally, so you can
read it offline. On UNIX systems, `/usr/local/share/doc/rust` is the location.
On Windows, it's in a `share/doc` directory, inside wherever you installed Rust
to.
"The Rust Programming Language" This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section.
2014-12-02 08:20:48 -06:00
If not, there are a number of places where you can get help. The easiest is
More editing work on TRPL Fill out blank section headers. Copy edit the entire first section.
2015-04-09 14:17:31 -05:00
[the #rust IRC channel on irc.mozilla.org][irc], which you can access through
[Mibbit][mibbit]. Click that link, and you'll be chatting with other Rustaceans
(a silly nickname we call ourselves), and we can help you out. Other great
Fix link formatting error Had a newline in middle of a link, causing the link text to be shown with `[]`.
2015-04-15 11:51:34 -05:00
resources include [the user’s forum][users], and
Fix link id for stackoverflow The document does not display properly if the link id contains a space.
2015-04-16 04:35:33 -05:00
[Stack Overflow][stackoverflow].
More editing work on TRPL Fill out blank section headers. Copy edit the entire first section.
2015-04-09 14:17:31 -05:00
[irc]: irc://irc.mozilla.org/#rust
[mibbit]: http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust
[users]: http://users.rust-lang.org/
Fix link id for stackoverflow The document does not display properly if the link id contains a space.
2015-04-16 04:35:33 -05:00
[stackoverflow]: http://stackoverflow.com/questions/tagged/rust
Reference in New Issue Copy Permalink