Skip to content

Commit 99519cc

Browse files
committed
auto merge of #15162 : steveklabnik/rust/install_instructions, r=brson
This has my voice *very strongly*. I'm not sure if it's too much. I'd find it okay if I had to tone it back, and I don't want it to be _too strong_, but clinical docs are boring.
2 parents edb4e59 + a8ddab4 commit 99519cc

File tree

1 file changed

+100
-1
lines changed

1 file changed

+100
-1
lines changed

src/doc/guide.md

+100-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,103 @@ displayed here in line with Rust's open development policy. Please open any
77
issues you find as usual.
88
</div>
99

10-
Coming soon. :)
10+
## Welcome!
11+
12+
Hey there! Welcome to the Rust guide. This is the place to be if you'd like to
13+
learn how to program in Rust. Rust is a systems programming language with a
14+
focus on "high-level, bare-metal programming": the lowest level control a
15+
programming language can give you, but with zero-cost, higher level
16+
abstractions, because people aren't computers. We really think Rust is
17+
something special, and we hope you do too.
18+
19+
To show you how to get going with Rust, we're going to write the traditional
20+
"Hello, World!" program. Next, we'll introduce you to a tool that's useful for
21+
writing real-world Rust programs and libraries: "Cargo." Then, we'll show off
22+
Rust's features by writing a little program together.
23+
24+
Sound good? Let's go!
25+
26+
## Installing Rust
27+
28+
The first step to using Rust is to install it! There are a number of ways to
29+
install Rust, but the easiest is to use the the `rustup` script. If you're on
30+
Linux or a Mac, All you need to do is this:
31+
32+
```{ignore}
33+
$ curl -s http://www.rust-lang.org/rustup.sh | sudo sh
34+
```
35+
36+
(If you're concerned about `curl | sudo sh`, please keep reading. Disclaimer
37+
below.)
38+
39+
If you're on Windows, please [download this .exe and run
40+
it](http://static.rust-lang.org/dist/rust-nightly-install.exe).
41+
42+
If you decide you don't want Rust anymore, we'll be a bit sad, but that's okay.
43+
Not every programming language is great for everyone. Just pass an argument to
44+
the script:
45+
46+
```{ignore}
47+
$ curl -s http://www.rust-lang.org/rustup.sh | sudo sh -s -- --uninstall
48+
```
49+
50+
If you used the Windows installer, just re-run the `.exe` and it will give you
51+
an uninstall option.
52+
53+
You can re-run this script any time you want to update Rust. Which, at this
54+
point, is often. Rust is still pre-1.0, and so people assume that you're using
55+
a very recent Rust.
56+
57+
This brings me to one other point: some people, and somewhat rightfully so, get
58+
very upset when we tell you to `curl | sudo sh`. And they should be! Basically,
59+
when you do this, you are trusting that the good people who maintain Rust
60+
aren't going to hack your computer and do bad things. That's a good instinct!
61+
If you're one of those people, please check out the documentation on [building
62+
Rust from Source](https://github.com/rust-lang/rust#building-from-source), or
63+
[the official binary downloads](http://www.rust-lang.org/install.html). And we
64+
promise that this method will not be the way to install Rust forever: it's just
65+
the easiest way to keep people updated while Rust is in its alpha state.
66+
67+
Oh, we should also mention the officially supported platforms:
68+
69+
* Windows (7, 8, Server 2008 R2), x86 only
70+
* Linux (2.6.18 or later, various distributions), x86 and x86-64
71+
* OSX 10.7 (Lion) or greater, x86 and x86-64
72+
73+
We extensively test Rust on these platforms, and a few others, too, like
74+
Android. But these are the ones most likely to work, as they have the most
75+
testing.
76+
77+
Finally, a comment about Windows. Rust considers Windows to be a first-class
78+
platform upon release, but if we're honest, the Windows experience isn't as
79+
integrated as the Linux/OS X experience is. We're working on it! If anything
80+
does not work, it is a bug. Please let us know if that happens. Each and every
81+
commit is tested against Windows just like any other platform.
82+
83+
If you've got Rust installed, you can open up a shell, and type this:
84+
85+
```{ignore}
86+
$ rustc --version
87+
```
88+
89+
You should see some output that looks something like this:
90+
91+
```{ignore}
92+
rustc 0.11.0-pre (443a1cd 2014-06-08 14:56:52 -0700)
93+
host: x86_64-unknown-linux-gnu
94+
```
95+
96+
If you did, Rust has been installed successfully! Congrats!
97+
98+
If not, there are a number of places where you can get help. The easiest is
99+
IRC, which you can access
100+
[here](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust). Click
101+
that link, and you'll be chatting with other Rustaceans (a silly nickname we
102+
call ourselves), and we can help you out. Other great resources include our
103+
[mailing list](https://mail.mozilla.org/listinfo/rust-dev),
104+
[subreddit](http://www.reddit.com/r/rust), and
105+
[StackOverflow](http://stackoverflow.com/questions/tagged/rust).
106+
107+
## Hello, world!
108+
109+
## Hello, Cargo!

0 commit comments

Comments
 (0)