Blame - README.md - external/github.com/rust-lang/rust

blob: ed3a353f0e689ee5439f3efcf72352797e550b62 [file] [log] [blame] [view]

Brian Anderson	a08c5aa	2012-07-10 05:18:37	[diff] [blame]	1	# The Rust Programming Language
Austin Seipp	62c4d2c	2012-01-23 21:53:12	[diff] [blame]	2
Brian Anderson	c92d2ed	2012-07-10 05:13:48	[diff] [blame]	3	This is a compiler for Rust, including standard libraries, tools and
				4	documentation.
				5
Jack Moffitt	8d64fa3	2013-07-18 23:27:43	[diff] [blame]	6	## Quick Start
Brian Anderson	c92d2ed	2012-07-10 05:13:48	[diff] [blame]	7
Jack Moffitt	8d64fa3	2013-07-18 23:27:43	[diff] [blame]	8	### Windows
Austin Seipp	62c4d2c	2012-01-23 21:53:12	[diff] [blame]	9
Jack Moffitt	8d64fa3	2013-07-18 23:27:43	[diff] [blame]	10	1. Download and use the [installer][win-exe].
				11	2. Read the [tutorial].
				12	2. Enjoy!
Austin Seipp	62c4d2c	2012-01-23 21:53:12	[diff] [blame]	13
Jack Moffitt	8d64fa3	2013-07-18 23:27:43	[diff] [blame]	14	> *Note:* Windows users should read the detailed
				15	> [getting started][wiki-start] notes on the wiki. Even when using
				16	> the binary installer the Windows build requires a MinGW installation,
				17	> the precise details of which are not discussed here.
				18
				19	[tutorial]: http://static.rust-lang.org/doc/tutorial.html
				20	[wiki-start]: https://github.com/mozilla/rust/wiki/Note-getting-started-developing-Rust
Brian Anderson	695cb9f	2013-09-21 23:25:08	[diff] [blame]	21	[win-exe]: http://static.rust-lang.org/dist/rust-0.8-install.exe
Jack Moffitt	8d64fa3	2013-07-18 23:27:43	[diff] [blame]	22
				23	### Linux / OS X
				24
				25	1. Install the prerequisites (if not already installed)
				26	* g++ 4.4 or clang++ 3.x
				27	* python 2.6 or later (but not 3.x)
				28	* perl 5.0 or later
				29	* gnu make 3.81 or later
				30	* curl
				31	2. Download and build Rust
				32	You can either download a [tarball] or build directly from the [repo].
				33
				34	To build from the [tarball] do:
				35
Brian Anderson	695cb9f	2013-09-21 23:25:08	[diff] [blame]	36	$ curl -O http://static.rust-lang.org/dist/rust-0.8.tar.gz
				37	$ tar -xzf rust-0.8.tar.gz
				38	$ cd rust-0.8
Jack Moffitt	8d64fa3	2013-07-18 23:27:43	[diff] [blame]	39
				40	Or to build from the [repo] do:
				41
				42	$ git clone https://github.com/mozilla/rust.git
				43	$ cd rust
				44
				45	Now that you have Rust's source code, you can configure and build it:
				46
				47	$ ./configure
				48	$ make && make install
				49
				50	You may need to use `sudo make install` if you do not normally have
				51	permission to modify the destination directory. The install locations can
				52	be adjusted by passing a `--prefix` argument to `configure`. Various other
				53	options are also supported, pass `--help` for more information on them.
				54
				55	When complete, `make install` will place several programs into
				56	`/usr/local/bin`: `rustc`, the Rust compiler; `rustdoc`, the
				57	API-documentation tool, and `rustpkg`, the Rust package manager and build
				58	system.
				59	3. Read the [tutorial].
				60	4. Enjoy!
				61
				62	[repo]: https://github.com/mozilla/rust
Brian Anderson	695cb9f	2013-09-21 23:25:08	[diff] [blame]	63	[tarball]: http://static.rust-lang.org/dist/rust-0.8.tar.gz
				64	[tutorial]: http://static.rust-lang.org/doc/0.8/tutorial.html
Jack Moffitt	8d64fa3	2013-07-18 23:27:43	[diff] [blame]	65
				66	## Notes
				67
				68	Since the Rust compiler is written in Rust, it must be built by a
				69	precompiled "snapshot" version of itself (made in an earlier state of
				70	development). As such, source builds require a connection to the Internet, to
				71	fetch snapshots, and an OS that can execute the available snapshot binaries.
Austin Seipp	62c4d2c	2012-01-23 21:53:12	[diff] [blame]	72
Brian Anderson	4c833af	2012-10-11 00:56:38	[diff] [blame]	73	Snapshot binaries are currently built and tested on several platforms:
Brian Anderson	3403e41	2012-07-10 05:20:32	[diff] [blame]	74
Brian Anderson	4c833af	2012-10-11 00:56:38	[diff] [blame]	75	* Windows (7, Server 2008 R2), x86 only
				76	* Linux (various distributions), x86 and x86-64
				77	* OSX 10.6 ("Snow Leopard") or greater, x86 and x86-64
Austin Seipp	62c4d2c	2012-01-23 21:53:12	[diff] [blame]	78
Brian Anderson	4c833af	2012-10-11 00:56:38	[diff] [blame]	79	You may find that other platforms work, but these are our "tier 1"
				80	supported build environments that are most likely to work.
Austin Seipp	62c4d2c	2012-01-23 21:53:12	[diff] [blame]	81
Jack Moffitt	8d64fa3	2013-07-18 23:27:43	[diff] [blame]	82	Rust currently needs about 1.8G of RAM to build without swapping; if it hits
				83	swap, it will take a very long time to build.
Brian Anderson	4c833af	2012-10-11 00:56:38	[diff] [blame]	84
Jack Moffitt	8d64fa3	2013-07-18 23:27:43	[diff] [blame]	85	There is lots more documentation in the [wiki].
Austin Seipp	62c4d2c	2012-01-23 21:53:12	[diff] [blame]	86
Jack Moffitt	8d64fa3	2013-07-18 23:27:43	[diff] [blame]	87	[wiki]: https://github.com/mozilla/rust/wiki
Austin Seipp	62c4d2c	2012-01-23 21:53:12	[diff] [blame]	88
				89
Brian Anderson	c92d2ed	2012-07-10 05:13:48	[diff] [blame]	90	## License
Austin Seipp	62c4d2c	2012-01-23 21:53:12	[diff] [blame]	91
Brian Anderson	11a9918	2012-12-28 21:40:33	[diff] [blame]	92	Rust is primarily distributed under the terms of both the MIT license
				93	and the Apache License (Version 2.0), with portions covered by various
				94	BSD-like licenses.
Austin Seipp	62c4d2c	2012-01-23 21:53:12	[diff] [blame]	95
Brian Anderson	11a9918	2012-12-28 21:40:33	[diff] [blame]	96	See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.
Brian Anderson	c92d2ed	2012-07-10 05:13:48	[diff] [blame]	97