Commit Graph

221 Commits

Author SHA1 Message Date
Nine
605381ad47 Capitalize ToC in README.md 2023-11-29 23:03:31 -06:00
Nine
b80d0749f4 Fix typo in README.md 2023-11-29 23:02:47 -06:00
Claes Gill
d7256a6a0d Updated README with expandable table of content. 2023-10-19 22:32:11 +02:00
AdityaPrakash
6ff3c3a421
typo in README.md 2023-10-06 09:05:38 +05:30
Alex Touchet
7bb9de87f6
Use consistent formatting in Readme 2023-07-01 21:14:20 -07:00
jyn
b556e28496 outline x.py alternate invocations to the dev guide
almost no one on windows builds from source unless they're contributing,
and `./x.py` just works on most unix systems.
2023-06-24 13:05:21 -05:00
jyn
8a9668d8e8 Update readme to suggest ./configure instead of printf
This also makes some other minor cleanups:
- Suggest `python x.py` on windows instead of `./x.py`, which usually
  doesn't work
- Move the "Configure and Make" section to a subsection of "Building on
  Unix"
- Mention `config.toml` earlier
- Suggest `x.py setup user` on Windows, since `configure` won't work
2023-04-19 09:50:21 -05:00
Thom Chiovoloni
fcb2a3665f
Rename config.toml.example to config.example.toml 2023-03-11 14:10:00 -08:00
0xf333
56d7b9ce1b Bages for easy access links to Rust community 2023-02-26 22:20:09 -05:00
Alex Touchet
8915ba7b1b
Improve Markdown styling in README 2022-12-28 21:47:09 -08:00
KaDiWa
9bf4036d17
readme: update section on how to run x.py 2022-12-26 00:33:32 +01:00
Gimbles
93ebf46526
Update README.md 2022-12-24 21:18:35 +05:30
Gimbles
d403d1af6d
Update README.md 2022-12-24 21:16:14 +05:30
Gimbles
a3cf58533f
Bold 2022-12-24 21:02:15 +05:30
Joshua Nelson
70a0e0a277 Remove ancient and outdated references to config.mk 2022-12-23 19:08:53 -06:00
Joshua Nelson
1bd1b25be8 Suggest profile = "user" in the README
This sets several useful defaults, like `extended = true`, and gives us a path forward for changing
global defaults without breaking distros.
2022-12-23 19:08:53 -06:00
Joshua Nelson
7dae1b0b07 Add detail about dependencies from the dev-guide
The goal is to remove this altogether from the dev-guide once this PR is merged.
2022-12-23 19:08:53 -06:00
Joshua Nelson
a06e5decaf Link to other resources instead of inlining their information
The other places are more accurate and up-to-date.

- Link to `std-dev-guide` in CONTRIBUTING.md

  Thom and Mara said the guide is in reasonably good shape, and it's tailored more closely to people working on the standard library.

- Link to CONTRIBUTING.md instead of rustc-dev-guide in the main readme

  CONTRIBUTING.md has more information and also links the std-dev-guide.

- Link to forge for the list of tested platforms; the one in the readme
  was hopelessly out of date.
2022-12-23 19:03:50 -06:00
zahash
e82922f8ea very minor readme.md changes 2022-09-12 09:01:54 +05:30
zahash
a91e6188e4 replace i.e. with e.g. in readme which is more accurate given the context 2022-09-11 21:15:55 +05:30
zahash
5b758f0d9a smol grammar changes to README.md 2022-09-11 16:39:19 +05:30
Tushar Dahiya
9397b6c38d
Update README.md 2022-08-23 23:27:23 +05:30
Josh Stone
d0142ce27a Increase the minimum linux-gnu versions
This is implementing the MCP from rust-lang/compiler-team#493. It is
increasing the minimum requirements of a couple Tier 1 targets, and
others at lower tiers, so this should go through FCP sign-offs for both
`T-compiler` and `T-release`.

The new `linux-gnu` baseline is kernel 3.2 and glibc 2.17. We will also
take that kernel as the minimum floor for _all_ `*-linux-*` targets, so
it may be broadly assumed in the implementation of the standard library.
That does not preclude specific targets from having greater requirements
where it makes sense, like a new arch needing something newer, or a
platform like `linux-android` choosing a newer baseline.
2022-08-03 20:34:58 -07:00
Lucas Thormann
c9340ec71b
Fix typo 2022-06-21 15:40:08 -05:00
Joshua Nelson
bb7ec7b7e9 Give people a single link they can click in the contributing guide
Doc Jones mentioned that one of the things making it hard to get started
is that the amount of information is overwhelming, between the
dev-guide, contributing guide, and discussion platforms. This gives
people a single link they can click to ask for help.
2021-11-22 13:10:22 -06:00
Yuki Okushi
7c06191d2c
Rollup merge of #85504 - liigo:patch-13, r=Mark-Simulacrum
the foundation owns rust trademarks
2021-07-01 05:20:54 +09:00
Alexander Melentyev
e84c9aed6d Delete spaces 2021-06-21 12:11:37 +03:00
Liigo Zhuang
9c65f9f470
this section is just about trademarks, not governance 2021-05-26 10:51:13 +08:00
Liigo Zhuang
2caaa07498
the foundation owns rust trademarks 2021-05-20 18:11:01 +08:00
Lee Bradley
4c12a5dc6c Add x.py pre-setup instructions
This change adds pre-setup instructions that outline how x.py requires
python to be setup and how to work around the problem of x.py failing to
locate python, especially now that Ubuntu 20.04's dropped default python
command is causing people to encounter this issue regularly.

See also: #71818
2021-05-18 01:01:28 -05:00
Trevor Spiteri
3a3e7ebdf0 update MSYS2 link in README
Now https://msys2.github.io/ redirects to https://www.msys2.org/, so
the README might just link to that immediately.
2021-03-10 08:41:53 +01:00
Wesley Wiser
52d9792bc8 Update README.md to use the correct cmake version number
LLVM requires at least cmake 3.13.4 and cmake is only required to build
LLVM.

Also closes #42555
2021-03-09 11:03:52 -05:00
Corey Farwell
d2cc79eaa2
Bring back a top level heading 2020-12-23 14:17:34 -05:00
Corey Farwell
4f4f7f2c7d
Remove giant badge in README 2020-12-17 22:55:01 -05:00
Camelid
6716c8320f bootstrap: Print units for "finished in xxx" message
It now says "finished in xxx seconds".

Also slightly improved some wording in the README.
2020-10-18 13:55:35 -07:00
qlcom
18ce4c1cfc
README.md: Remove prompts from code blocks 2020-09-18 21:08:48 +06:00
bors
78f4cbb1ef Auto merge of #76418 - jyn514:readme, r=Dylan-DPC
Move sections about contributing closer together in the README

This makes it easier to find what to do if you're interested in contributing.
2020-09-09 02:40:27 +00:00
Joshua Nelson
aee0ef13dd Remove duplicate 'note:' 2020-09-06 15:18:45 -04:00
Joshua Nelson
3ecfd5ca51 Move sections about contributing closer together 2020-09-06 15:14:29 -04:00
Camelid
8783c62f0c Add missing link in README 2020-09-02 18:42:27 -07:00
Lzu Tao
116ad98341 Remove tick for macOS x86 2020-09-01 01:11:05 +00:00
Lzu Tao
029ff37d30 Adjust Linux supported kernels and glibc 2020-08-31 14:43:54 +00:00
CDirkx
00d459a93f
Update MinGW instructions to include ninja
Added the `mingw-w64-x86_64-ninja` package to the build guide for MinGW, as well as a note not to use the `ninja` package from the `msys2` subsystem (doesn't handle paths correctly on windows).
2020-08-31 01:22:25 +02:00
Josh Triplett
30b7dac745 Set ninja=true by default
Ninja substantially improves LLVM build time. On a 96-way system, using
Make took 248s, and using Ninja took 161s, a 35% improvement.

We already require a variety of tools to build Rust. If someone wants to
build without Ninja (for instance, to minimize the set of packages
required to bootstrap a new target), they can easily set `ninja=false`
in `config.toml`.  Our defaults should help people build Rust (and LLVM)
faster, to speed up development.
2020-08-26 14:55:21 -07:00
Andreas Jonson
30659cd45e older toolchains not valid any more
with the change to llvm 10 the parameter
LLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN do not do any thing as
min and soft error is the same.
see 86b120e6f3/llvm/cmake/modules/CheckCompilerVersion.cmake
2020-07-19 16:53:37 +02:00
Valentin
df43dcd7d4 Fix "getting started" link
The previous link is 404.
2020-07-03 11:44:37 +02:00
Manish Goregaokar
dc6a19c2f0
Rollup merge of #73454 - mark-i-m:contributing, r=nikomatsakis
Move contributing.md to rustc-dev-guide and point at getting started

See description on https://github.com/rust-lang/rustc-dev-guide/pull/753
2020-07-02 15:55:50 -07:00
Anirban
4c33b7c8d6
Add responsiveness to logo
Added responsiveness to image logo based on device width (set at 90% of device width, which can be changed as per requirement)
2020-06-25 19:33:19 +05:30
Anirban
3a1ac28231
Added clickable-link
Linked the logo/svg to https://www.rust-lang.org/
(change if required)
2020-06-25 16:43:27 +05:30
Anirban
8edcc6d00d
Add alternate text for rust logo image 2020-06-25 16:32:54 +05:30