# The Rust Programming Language
This is a compiler for Rust, including standard libraries, tools and
-documentation.
+documentation. Rust is a systems programming language that is fast,
+memory safe and multithreaded, but does not employ a garbage collector
+or otherwise impose significant runtime overhead.
## Quick Start
-1. Download a [binary installer][installer] for your platform.
-2. Read [The Rust Programming Language][trpl].
-3. Enjoy!
+Read ["Installing Rust"] from [The Book].
-> ***Note:*** Windows users can read the detailed
-> [using Rust on Windows][win-wiki] notes on the wiki.
-
-[installer]: http://www.rust-lang.org/install.html
-[trpl]: http://doc.rust-lang.org/book/index.html
-[win-wiki]: https://github.com/rust-lang/rust/wiki/Using-Rust-on-Windows
+["Installing Rust"]: http://doc.rust-lang.org/book/installing-rust.html
+[The Book]: http://doc.rust-lang.org/book/index.html
## 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)
- * `perl` 5.0 or later
- * GNU `make` 3.81 or later
- * `curl`
- * `git`
-2. Download and build Rust:
-
- You can either download a [tarball] or build directly from the [repo].
- To build from the [tarball] do:
+ * `g++` 4.7 or `clang++` 3.x
+ * `python` 2.6 or later (but not 3.x)
+ * GNU `make` 3.81 or later
+ * `curl`
+ * `git`
- $ curl -O https://static.rust-lang.org/dist/rust-nightly.tar.gz
- $ tar -xzf rust-nightly.tar.gz
- $ cd rust-nightly
+2. Clone the [source] with `git`:
- Or to build from the [repo] do:
+ ```sh
+ $ git clone https://github.com/rust-lang/rust.git
+ $ cd rust
+ ```
- $ git clone https://github.com/rust-lang/rust.git
- $ cd rust
+[source]: https://github.com/rust-lang/rust
- Now that you have Rust's source code, you can configure and build it:
+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
- API-documentation tool.
-3. Read [The Rust Programming Language][trpl].
-4. Enjoy!
+ API-documentation tool. This install does not include [Cargo],
+ Rust's package manager, which you may also want to build.
+
+[Cargo]: https://github.com/rust-lang/cargo
### Building on Windows
-To easily build on windows we can use [MSYS2](http://sourceforge.net/projects/msys2/):
+[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.
- $ pacman -S mingw-w64-i686-toolchain
- $ pacman -S base-devel
+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
+ ```
-3. With that now start `mingw32_shell.bat` from where you installed MSYS2 (i.e. `C:\msys`).
-4. From there just navigate to where you have Rust's source code, configure and build it:
+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.
- $ ./configure
- $ make && make install
+4. Navigate to Rust's source code, configure and build it:
-[repo]: https://github.com/rust-lang/rust
-[tarball]: https://static.rust-lang.org/dist/rust-nightly.tar.gz
-[trpl]: http://doc.rust-lang.org/book/index.html
+ ```sh
+ $ ./configure
+ $ make && make install
+ ```
## Notes
Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits
swap, it will take a very long time to build.
-There is a lot more documentation in the [wiki].
+There is more advice about hacking on Rust in [CONTRIBUTING.md].
-[wiki]: https://github.com/rust-lang/rust/wiki
+[CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
-## Getting help and getting involved
+## Getting Help
The Rust community congregates in a few places:
-* [StackOverflow] - Get help here.
-* [/r/rust] - General discussion.
-* [discuss.rust-lang.org] - For development of the Rust language itself.
+* [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
-[discuss.rust-lang.org]: http://discuss.rust-lang.org/
+[users.rust-lang.org]: http://users.rust-lang.org/
+
+## Contributing
+
+To contribute to Rust, please see [CONTRIBUTING](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.
+
+[IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
+[#rust]: irc://irc.mozilla.org/rust
## License
and the Apache License (Version 2.0), with portions covered by various
BSD-like licenses.
-See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.
+See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and [COPYRIGHT](COPYRIGHT) for details.
projects / rustc.git / blobdiff