Commit graph

90 commits

Author SHA1 Message Date
Joshua Olson 797e6fc41b added link for issue mentioned in readme
‌ ‌ ▲
▲‌ ▲
2016-01-15 20:50:03 -07:00
Manish Goregaokar 40f06b4bb1 Rollup merge of #30626 - steveklabnik:gh30618, r=luqmana
Fixes #30618
2016-01-14 11:04:39 +05:30
Steve Klabnik 011a23e8bc Update MinGW details in the README
Fixes #29649
2016-01-05 11:36:15 -05:00
Steve Klabnik cf23dae2ee We actually require python 2.7
Fixes #30618
2015-12-29 17:44:30 -05:00
petevine 5294f2080b README.md - RAM requirement on 32-bit *nix
Running `/usr/bin/time -v make` to build rust (using local llvm) shows the maximum memory usage at 715 megabytes on 32-bit x86 (on arm linux it's even less @ 580M).

Reworded according to @brson's input.
2015-12-07 01:12:53 +01:00
Brian Anderson 7793829877 Redo the README intro again 2015-11-09 13:32:30 -08:00
Vadim Chugunov 363deb0864 Formatting 2015-11-01 16:24:51 -08:00
Vadim Chugunov ab10cb7443 Clarify Windows gcc setup instructions. 2015-11-01 12:41:32 -08:00
bors 0be1bcd06a Auto merge of #29229 - SingingTree:reflect_28260_in_readme, r=alexcrichton
This PR adds a note to the end of the Windows build instructions to reflect the issues detailed in #28260, as well as a work around using older versions of gcc. I've avoided going into detail as I did not wish to bloat the README, and so that the changes are easy to yank once the issue is resolved.
2015-10-24 23:19:14 +00:00
Bryce Van Dyk a17d77b7f2 Reference #28260 in the README 2015-10-24 13:13:01 +13:00
Bryce Van Dyk ee24add8a0 Update readme to reflect #28260 and a workaround 2015-10-22 21:52:17 +13:00
Bryce Van Dyk 3ed49ef6f3 Add example to install git in MSYS2 2015-10-20 21:02:19 +13:00
Carlos Liam f9d056f1b7 Clean whitespace
Remove leading newlines; replace lines containing only whitespace with empty lines; replace multiple trailing newlines with a single newline; remove trailing whitespace in lines
2015-10-19 11:16:31 -04:00
Carlos Liam 3967e1c940 Clean newlines 2015-10-06 11:14:11 -04:00
Jake Shadle 7ab8ed84fd Update README.md
Use suggested composite command instead of 2 separate commands.
2015-08-28 20:24:13 +02:00
Jake Shadle 371c0ead1f Update README.md
Folded in suggestion from @brson to simply put the mirror update step in the regular set of tool chain install commands.
2015-08-28 09:46:23 +02:00
Jake Shadle 10d3873fb5 Update README.md
Encountered an issue going through the guide for installing the `mingw` toolchain on Windows with msys2, after some googling I found the [solution](https://github.com/Alexpux/MSYS2-packages/issues/163#issuecomment-73555971) and thought it would be good to update the README so people don't get frustrated. :)
2015-08-27 17:00:06 +02:00
Steve Klabnik fd53ea28d8 Add notes about building documentation to the README.
Fixes #27632
2015-08-18 13:49:20 -04:00
Eli Friedman bbbfed2f93 Use https URLs to refer to rust-lang.org where appropriate.
Also fixes a few outdated links.
2015-08-09 14:28:46 -07:00
Kagami Sascha Rosylight f24089cfd1 MYSY2 -> MSYS2 2015-07-03 17:16:13 +09:00
Steve Klabnik 9d641316f1 Rollup merge of #26373 - tshepang:patch-2, r=steveklabnik 2015-06-30 15:37:44 -04:00
Tshepang Lekhonkhobe a8680deb7f README: improve description of Rust 2015-06-18 23:48:51 +02:00
Tshepang Lekhonkhobe 1cf6a82038 README: make it clear rustc is the compiler 2015-06-17 22:13:37 +02:00
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 #5831.
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 #21242 - 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 #17876 : 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