Skip to content

Readme cleanup #22395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Feb 19, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 24 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# 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

Read ["Installing Rust"][install] from [The Book][trpl].
Read ["Installing Rust"] from [The Book].

[install]: http://doc.rust-lang.org/book/installing-rust.html
[trpl]: http://doc.rust-lang.org/book/index.html
["Installing Rust"]: http://doc.rust-lang.org/book/installing-rust.html
[The Book]: http://doc.rust-lang.org/book/index.html

## Building from Source

Expand All @@ -19,22 +21,14 @@ Read ["Installing Rust"][install] from [The Book][trpl].
* `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:

$ curl -O https://static.rust-lang.org/dist/rustc-nightly-src.tar.gz
$ tar -xzf rustc-nightly-src.tar.gz
$ cd rustc-nightly

Or to build from the [repo] do:
2. Clone the [source] with `git`:

$ git clone https://github.com/rust-lang/rust.git
$ cd rust

Now that you have Rust's source code, you can configure and build it:
[source]: https://github.com/rust-lang/rust

3. Build and install:

$ ./configure
$ make && make install
Expand All @@ -46,7 +40,10 @@ Read ["Installing Rust"][install] from [The Book][trpl].

When complete, `make install` will place several programs into
`/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
API-documentation tool.
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

Expand All @@ -72,9 +69,6 @@ $ pacman -S base-devel
$ ./configure
$ make && make install

[repo]: https://github.com/rust-lang/rust
[tarball]: https://static.rust-lang.org/dist/rustc-nightly-src.tar.gz

## Notes

Since the Rust compiler is written in Rust, it must be built by a
Expand All @@ -94,9 +88,9 @@ supported build environments that are most likely to work.
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

Expand All @@ -114,6 +108,14 @@ The Rust community congregates in a few places:

To contribute to Rust, please see [CONTRIBUTING.md](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

Rust is primarily distributed under the terms of both the MIT license
Expand Down
2 changes: 1 addition & 1 deletion src/llvm
Submodule llvm updated 34 files
+6 −0 include/llvm/CodeGen/MachineModuleInfo.h
+6 −6 lib/Analysis/IPA/InlineCost.cpp
+8 −7 lib/CodeGen/AsmPrinter/EHStreamer.cpp
+13 −4 lib/CodeGen/AsmPrinter/EHStreamer.h
+148 −1 lib/CodeGen/AsmPrinter/Win64Exception.cpp
+4 −0 lib/CodeGen/AsmPrinter/Win64Exception.h
+8 −0 lib/CodeGen/MachineModuleInfo.cpp
+1 −1 lib/CodeGen/Passes.cpp
+13 −9 lib/CodeGen/SelectionDAG/DAGCombiner.cpp
+3 −5 lib/CodeGen/SelectionDAG/LegalizeVectorOps.cpp
+29 −4 lib/CodeGen/SelectionDAG/SelectionDAGBuilder.cpp
+2 −0 lib/CodeGen/SelectionDAG/SelectionDAGBuilder.h
+63 −1 lib/CodeGen/SelectionDAG/SelectionDAGISel.cpp
+0 −3 lib/IR/DebugInfo.cpp
+3 −4 lib/IR/Type.cpp
+6 −11 lib/MC/WinCOFFObjectWriter.cpp
+0 −2 lib/Target/X86/X86ISelLowering.cpp
+2 −9 lib/Transforms/InstCombine/InstCombineLoadStoreAlloca.cpp
+0 −41 lib/Transforms/Instrumentation/InstrProfiling.cpp
+0 −3 lib/Transforms/Scalar/EarlyCSE.cpp
+4 −16 lib/Transforms/Vectorize/SLPVectorizer.cpp
+0 −23 test/CodeGen/PowerPC/vsel-prom.ll
+0 −35 test/CodeGen/X86/constant-combines.ll
+0 −12 test/CodeGen/X86/pshufb-mask-comments.ll
+175 −0 test/CodeGen/X86/seh-basic.ll
+196 −0 test/CodeGen/X86/seh-safe-div.ll
+0 −33 test/DebugInfo/location-verifier.ll
+0 −25 test/MC/COFF/diff.s
+1 −10 test/Transforms/EarlyCSE/basic.ll
+0 −19 test/Transforms/Inline/inline-indirect.ll
+0 −2 test/Transforms/InstCombine/loadstore-metadata.ll
+0 −50 test/Transforms/SLPVectorizer/X86/bad_types.ll
+0 −9 test/tools/gold/no-map-whole-file.ll
+9 −10 tools/gold/gold-plugin.cpp