Commit Graph

217 Commits

Author SHA1 Message Date
Nick Hamann
74f1818608 Update README
Tries to make the introductory portion of the README flow better.
2015-05-15 00:43:40 -05:00
Richo Healey
6f3701d604 readme: Rework the arch support matrix 2015-05-12 09:31:44 -07:00
Tamir Duberstein
f5765793b6 Strip trailing whitespace 2015-03-15 11:25:43 -07:00
Daniel Lobato García
13d5e5712a Link README to license & copyright files
A minor change to avoid making the reader think 'where is this'.
2015-03-08 23:37:23 +02:00
Kevin Yap
24fa6be7c6 Miscellaneous README changes
- Various grammatical changes.
- Use triple-backtick syntax and sh highlighting for code blocks.
- Fix indentation of code block in step 2 of "Building on Windows".
- Use title case for "Getting Help" subheading.
2015-02-21 23:40:09 -08:00
Brian Anderson
c273571bfd Remove mention of wiki from README 2015-02-18 13:48:46 -08:00
Brian Anderson
7430e58e65 Address review feedback 2015-02-18 13:46:55 -08:00
Brian Anderson
73cc4ed4da README: Simplify markdown 2015-02-18 13:46:55 -08:00
Brian Anderson
aaabdbfe04 README: Add one sentence about what Rust is.
Most people don't know what Rust is.
2015-02-18 13:46:55 -08:00
Brian Anderson
46189559a9 README: Add a link to #rust 2015-02-18 13:46:55 -08:00
Brian Anderson
9265e13867 README: Make the wiki links more useful.
The page we want them to find is 'getting started developing'.
2015-02-18 13:46:55 -08:00
Brian Anderson
21ed20baf9 README: Give a hint about how to build Cargo from source.
Just a hint.
2015-02-18 13:46:55 -08:00
Brian Anderson
4acc483106 Simplify README by not talking about the source tarball option
I believe that few enough people build from source tarballs that
we don't have to talk about it explicitly.
2015-02-18 13:46:55 -08:00
Steve Klabnik
f645cad3a1 CONTRIBUTING.md redux
This redux of CONTRIBUTING.md adds in more information, including
subsuming both compliment-bugreport.md and Note-development-policy
in the wiki.

I only glanced at the broad TOC of Note-development-policy, and did
not use the text as the basis for the re-write. This will then address
the last outstanding part of .
2015-02-16 04:46:40 -05:00
Brian Anderson
9df38bf658 Remove some irrelevant text from README
The quick start already links to the book. I think its not necessary
to do in the build instructions.
2015-02-12 20:36:21 -08:00
Brian Anderson
8dcc886d68 Change README quick start instructions to defer entirely to the book. 2015-02-12 20:36:21 -08:00
Brian Anderson
5716ede92c doc: Add links to users.rust-lang.org 2015-01-29 15:49:00 -08:00
Manish Goregaokar
7abbc96e66 Rollup merge of 21708 - brson:internals, r=huonw 2015-01-29 03:13:53 +05:30
John Hodge
1c502f1d43 README.md - Fix source tarball link 2015-01-28 10:12:54 +08:00
Brian Anderson
94404070d6 discuss.rust-lang.org -> internals.rust-lang.org 2015-01-27 15:44:05 -08:00
bors
6869645e86 Auto merge of - richo:no-perl, r=brson
There's only one build-critical path in which perl is used, and it was to do a text replacement trivially achievable with sed(1).

I ported the indenter script because it [appears to be used][indenter], but removed check links because it appears to be entirely out of date.

[indenter]: https://github.com/rust-lang/rust/blob/master/src/librustc/util/common.rs#L60-70
2015-01-21 11:07:31 +00:00
Richo Healey
948dcaa72b Remove perl as a dependency 2015-01-16 08:49:54 -08:00
Steve Klabnik
599232503a Add notes about 32 vs 64 bit Windows 2015-01-13 10:43:52 -05:00
Steve Klabnik
0017bfa002 Link to a better place for msys2
This is much more helpful.
2015-01-12 15:56:16 -05:00
Steve Klabnik
16a6ebd1f6 "The Rust Programming Language"
This pulls all of our long-form documentation into a single document,
nicknamed "the book" and formally titled "The Rust Programming
Language."

A few things motivated this change:

* People knew of The Guide, but not the individual Guides. This merges
  them together, helping discoverability.
* You can get all of Rust's longform documentation in one place, which
  is nice.
* We now have rustbook in-tree, which can generate this kind of
  documentation. While its style is basic, the general idea is much
  better: a table of contents on the left-hand side.
* Rather than a almost 10,000-line guide.md, there are now smaller files
  per section.
2015-01-08 12:02:11 -05:00
bors
36d0346dff auto merge of : ruud-v-a/rust/patch-1, r=alexcrichton
The Windows-specific instruction under 'Quick Start' linked the wiki article on getting started developing Rust itself, but the quick start is just about obtaining a working Rust installation. The actual wiki page with Windows-specific instructions was difficult to find.

The most important thing to note on Windows is that you need mingw-builds, and it is totally not obvious. The only place where I have seen it mentioned is the wiki page, which was difficult to find before.
2014-10-13 21:32:43 +00:00
Taylor Hutchison
4474eab417 Update README.md
Added 64-bit Windows support to the list of platforms. Support for 64-bit Windows was added in Rust 0.12.0. See  https://mail.mozilla.org/pipermail/rust-dev/2014-October/011267.html for the release notes.
2014-10-09 23:41:30 -05:00
Ruud van Asseldonk
3431c0ab44 readme: Link 'Using' wiki page instead of 'Getting started'.
The Windows-specific instruction under 'Quick Start' linked the wiki article on getting started developing Rust itself, but the quick start is just about obtaining a working Rust installation. The actual wiki page with Windows-specific instructions was difficult to find.
2014-10-09 00:32:22 +02:00
Steve Klabnik
a99ba25f2b Replace the Tutorial with the Guide.
The Guide isn't 100% perfect, but it's basically complete. It's
certainly better than the tutorial is. Time to start pointing more
people its way.

I also just made it consistent to call all things 'guides' rather than
tutorials.

Fixes . This is the big one.

And two bugs that just go away.

Fixes .
Fixes .
2014-09-11 16:21:32 -04:00
Brian Anderson
cd1fabe55e Add links to forums in README.md, including discuss.rust-lang.org 2014-09-09 13:08:14 -07:00
klutzy
a3d77e616b configure: Recognize i686 build on msys2 2014-08-23 01:47:37 +09:00
Brian Anderson
21a70b38ba Update docs to use HTTPS for static.rust-lang.org addresses
cc 
2014-08-11 12:31:16 -07:00
Ruud van Asseldonk
9df25449f2 fix typo in readme 2014-06-30 11:17:25 +02:00
Luqman Aden
8b83355f14 README: Add instructions for building on windows. 2014-06-26 20:17:24 -04:00
Brian Anderson
f4ae8a83f9 Update repo location 2014-06-16 18:16:36 -07:00
Alex Crichton
799ddba8da Change static.rust-lang.org to doc.rust-lang.org
The new documentation site has shorter urls, gzip'd content, and index.html
redirecting functionality.
2014-05-21 19:55:39 -07:00
James Laverack
72f478f0e8 Update minimum g++ version in documentation
Version changed due to a newer requirement in LLVM.
2014-05-05 03:03:00 +01:00
mdinger
065c4a6967 Add git to README.md dependency list because configure requires it 2014-04-18 14:50:31 -04:00
free-Runner
14f2464801 Fixed broken tutorial link 2014-04-06 16:06:46 -04:00
Falco Hirschenberger
ba9c51d20f Update README.md
Fix typo
2014-04-04 13:22:52 -07:00
Brian Anderson
0875ffcbff Bump version to 0.11-pre
This also changes some of the download links in the documentation
to 'nightly'.
2014-04-03 16:28:46 -07:00
Alex Crichton
46867cc3e4 Tweak the installation instructions in the README
Update the instructions to reflect that we have binary installers for all
supported platforms, and move the building from source directions into a
dedicated "Building from Source" directory.
2014-04-02 16:59:39 -07:00
Alex Crichton
a5681d2590 Bump version to 0.10 2014-03-31 14:40:44 -07:00
Corey Richardson
25fe2cadb1 Remove rustpkg.
I'm sorry :'(

Closes 
2014-02-02 03:08:56 -05:00
Daniel Micay
b5334b3c0d mark the minimum supported Linux kernel version
This is just taken from the binary itself. It would be nice to mark the
minimum glibc version too, and the corresponding RHEL/CentOS version.
2014-01-31 21:43:08 -08:00
Daniel Micay
c9dd1ce89a mark Windows 8 as supported 2014-01-31 21:43:08 -08:00
Daniel Micay
d244512626 bump minimum supported OS X version to 10.7
Closes 
Closes 
Closes 
2014-01-31 21:43:08 -08:00
Adrien Tétar
a30d61b05a Various READMEs and docs cleanup
Noticeably closes .
2014-01-11 19:41:31 +01:00
Brian Anderson
1155ee9ee9 Bump more version numbers to 0.9 2014-01-02 10:55:28 -08:00
Brian Anderson
695cb9fc2b Update version numbers to 0.8 2013-09-21 16:25:08 -07:00
NiccosSystem
5708b91969 Fix broken tutorial link 2013-09-19 17:18:40 +02:00
Jack Moffitt
8d64fa3288 Reorganize README to make it more clear.
This also adds a note about required memory usage and instructions for
building from Git.
2013-07-19 20:52:16 -04:00
Brian Anderson
d5c5ce3f8d Update verison numbers in README.md 2013-06-30 21:08:48 -07:00
Graydon Hoare
951f460aa8 tidy version numbers and copyright dates 2013-04-01 16:15:49 -07:00
Zack Corr
621c791ded Rename cargo to rustpkg and start over fresh 2013-02-15 18:04:10 -08:00
Graydon Hoare
3c4e30becd README.md, mention curl not wget. 2013-02-01 17:10:36 -08:00
Brian Anderson
11a9918ae7 Wrap lines 2012-12-28 13:41:25 -08:00
Lenny222
c7d48eaa99 MIT + Apache 2 dual license 2012-12-28 13:41:25 -08:00
Graydon Hoare
dbd36111fe bump 0.5 => 0.6, redirect some URLs in docs. 2012-12-21 15:35:49 -08:00
Brian Anderson
6742c982a4 Bump version numbers in docs 2012-12-19 18:03:03 -08:00
Brian Anderson
4c833af038 Copy README install instructions from tutorial 2012-10-10 17:56:38 -07:00
Brian Anderson
7350eba4b4 Update README.md 2012-09-20 02:08:11 -06:00
Brian Anderson
920bc0fe49 Update version number in README.md 2012-09-14 21:19:27 -07:00
Brian Anderson
57e160b29d 0.2 -> 0.3 2012-07-10 11:53:22 -07:00
Brian Anderson
3403e41b2c Use correct markdown in README.md 2012-07-09 22:20:32 -07:00
Brian Anderson
a08c5aa947 Capitalize 'Rust Programming Language' in README.md 2012-07-09 22:18:42 -07:00
Brian Anderson
c92d2ed4c9 Merge README.txt and INSTALL.txt into README.md 2012-07-09 22:14:20 -07:00