From c92d2ed4c957c8fa94238061c1f4d3e46e598cc5 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Mon, 9 Jul 2012 22:13:48 -0700 Subject: [PATCH] Merge README.txt and INSTALL.txt into README.md --- INSTALL.txt => README.md | 27 ++++++++++++++++----------- README.txt | 6 ------ 2 files changed, 16 insertions(+), 17 deletions(-) rename INSTALL.txt => README.md (80%) delete mode 100644 README.txt diff --git a/INSTALL.txt b/README.md similarity index 80% rename from INSTALL.txt rename to README.md index 73b95856b1089..d79c709370e53 100644 --- a/INSTALL.txt +++ b/README.md @@ -1,7 +1,10 @@ -### Installing Rust +# The Rust programming language -Source build -========================= +This is a compiler for Rust, including standard libraries, tools and +documentation. + + +## Installation The Rust compiler is slightly unusual in that it is written in Rust and therefore must be built by a precompiled "snapshot" version of itself (made in @@ -27,10 +30,6 @@ To build from source you will also need the following prerequisite packages: * gnu make 3.81 or later * curl - -Building and installing -========================= - Assuming you're on a relatively modern Linux/OSX system and have met the prerequisites, something along these lines should work: @@ -54,9 +53,15 @@ configure. Various other options are also supported, pass --help for more information on them. -More help -========================= +## License + +Rust is primarily distributed under the terms of the MIT license, with +portions covered by various BSD-like licenses. + +See LICENSE.txt for complete terms of copyright and redistribution. + -The tutorial is a good starting point: +## More help - http://dl.rust-lang.org/doc/tutorial.html +The [tutorial](http://dl.rust-lang.org/doc/tutorial.html) is a good +starting point. diff --git a/README.txt b/README.txt deleted file mode 100644 index 25a492673aa9f..0000000000000 --- a/README.txt +++ /dev/null @@ -1,6 +0,0 @@ -This is a compiler and suite of associated libraries and documentation for the -Rust programming language. - -See LICENSE.txt for terms of copyright and redistribution. - -See http://www.rust-lang.org for more information.