Go to file

Alex Crichton e523f99fb9 rustdoc: Add the ability to input json This modifies the command-line usage of rustdoc to intake its own JSON output as well as a rust source file. This also alters the command line from `rustdoc input file` to `rustdoc file` with the input/output formats specified as -r and -w, respectively. When using a JSON input, no passes or plugins are re-run over the json, instead the output is generated directly from the JSON that was provided. Passes and plugins are still run on rust source input, however.		2013-09-30 20:31:19 -07:00
doc	auto merge of #9589 : thestinger/rust/tutorial, r=alexcrichton	2013-09-28 16:21:04 -07:00
man	Update rustpkg manpage to add init.	2013-09-19 12:58:29 -07:00
mk	rustdoc: Add the ability to input json	2013-09-30 20:31:19 -07:00
src	rustdoc: Add the ability to input json	2013-09-30 20:31:19 -07:00
.gitattributes	stop fighting with rust logo filetype.	2013-09-25 23:52:08 +02:00
.gitignore	Ignore the generated docs for libextra	2013-05-25 17:07:18 +10:00
.gitmodules	Upgrade libuv to the current master (again)	2013-09-06 11:12:49 -07:00
.mailmap	.mailmap: tolerate different names, emails in shortlog	2013-06-05 23:26:00 +05:30
AUTHORS.txt	Update AUTHORS.txt	2013-09-24 16:26:27 -07:00
configure	rustdoc: Add sundown to src/rt/	2013-09-25 14:27:41 -07:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2013-06-13 15:41:34 -06:00
COPYRIGHT	add gitattributes and fix whitespace issues	2013-05-03 20:01:42 -04:00
LICENSE-APACHE
LICENSE-MIT
Makefile.in	auto merge of #9542 : pnkfelix/rust/fsk-fix-issue-9531, r=thestinger	2013-09-28 15:01:38 -07:00
README.md	Update version numbers to 0.8	2013-09-21 16:25:08 -07:00
RELEASES.txt	0.8 will be in September	2013-09-25 11:38:44 -07:00

README.md

The Rust Programming Language

This is a compiler for Rust, including standard libraries, tools and documentation.

Quick Start

Windows

Download and use the installer.
Read the tutorial.
Enjoy!

Note: Windows users should read the detailed getting started notes on the wiki. Even when using the binary installer the Windows build requires a MinGW installation, the precise details of which are not discussed here.

Linux / OS X

Install the prerequisites (if not already installed)
- g++ 4.4 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
Download and build Rust You can either download a tarball or build directly from the repo.

To build from the tarball do:
```
 $ curl -O http://static.rust-lang.org/dist/rust-0.8.tar.gz
 $ tar -xzf rust-0.8.tar.gz
 $ cd rust-0.8
```
Or to build from the repo do:
```
 $ git clone https://github.com/mozilla/rust.git
 $ cd rust
```
Now that you have Rust's source code, you can configure and build it:
```
 $ ./configure
 $ make && make install
```
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; rustdoc, the API-documentation tool, and rustpkg, the Rust package manager and build system.
Read the tutorial.
Enjoy!

Notes

Since the Rust compiler is written in Rust, it must be built by a precompiled "snapshot" version of itself (made in an earlier state of development). As such, source builds require a connection to the Internet, to fetch snapshots, and an OS that can execute the available snapshot binaries.

Snapshot binaries are currently built and tested on several platforms:

Windows (7, Server 2008 R2), x86 only
Linux (various distributions), x86 and x86-64
OSX 10.6 ("Snow Leopard") or greater, x86 and x86-64

You may find that other platforms work, but these are our "tier 1" supported build environments that are most likely to work.

Rust currently needs about 1.8G of RAM to build without swapping; if it hits swap, it will take a very long time to build.

There is lots more documentation in the wiki.

License

Rust is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses.