about summary refs log tree commit diff
path: root/README.md
AgeCommit message (Collapse)AuthorLines
2019-04-12Add a link to the licenses pageAndrew Xu-0/+4
2019-04-06Add summary and reference to Rust trademark guideAndrew Xu-0/+12
2019-03-20Update build instructions in README.mdEddie Kovsky-0/+16
Add additional instructions when `sudo ./x.py install` fails to complete the build. This resolves issues #40108 and #49269.
2019-01-18Update README.mdWho? Me?!-1/+5
Point contributors to the rustc-guide...
2019-01-11Remove submodule step from READMENick Cameron-1/+0
Since the bootstrap does it now
2018-12-30Remove mention of required memory to buildSimonas Kazlauskas-8/+5
Because it, obviously, changes all the time and 600MiB is way out-of-date now.
2018-12-10fix install broken linkmisagh-1/+1
2018-11-26rustc-guide has movedMark Mansi-1/+1
2018-09-08docs: Use dollar sign for all bash promptsBehnam Esfahbod-3/+3
Making it consistent across the board, as most of them already use `$`. Also split one continues bash run into two, to make it easier see different runs: one with warning and another with error.
2018-07-04Add a link to the rustc docsmark-2/+5
2018-06-13Update README.mdDhirendra Kumar Kashyap-3/+3
2018-06-13Update README.mdDhirendra Kumar Kashyap-6/+6
Corrected the grammar of the document.
2018-05-31Update build instructionsAbhishek koserwal-0/+1
2018-03-03rust: Import LLD for linking wasm objectsAlex Crichton-3/+0
This commit imports the LLD project from LLVM to serve as the default linker for the `wasm32-unknown-unknown` target. The `binaryen` submoule is consequently removed along with "binaryen linker" support in rustc. Moving to LLD brings with it a number of benefits for wasm code: * LLD is itself an actual linker, so there's no need to compile all wasm code with LTO any more. As a result builds should be *much* speedier as LTO is no longer forcibly enabled for all builds of the wasm target. * LLD is quickly becoming an "official solution" for linking wasm code together. This, I believe at least, is intended to be the main supported linker for native code and wasm moving forward. Picking up support early on should help ensure that we can help LLD identify bugs and otherwise prove that it works great for all our use cases! * Improvements to the wasm toolchain are currently primarily focused around LLVM and LLD (from what I can tell at least), so it's in general much better to be on this bandwagon for bugfixes and new features. * Historical "hacks" like `wasm-gc` will soon no longer be necessary, LLD will [natively implement][gc] `--gc-sections` (better than `wasm-gc`!) which means a postprocessor is no longer needed to show off Rust's "small wasm binary size". LLD is added in a pretty standard way to rustc right now. A new rustbuild target was defined for building LLD, and this is executed when a compiler's sysroot is being assembled. LLD is compiled against the LLVM that we've got in tree, which means we're currently on the `release_60` branch, but this may get upgraded in the near future! LLD is placed into rustc's sysroot in a `bin` directory. This is similar to where `gcc.exe` can be found on Windows. This directory is automatically added to `PATH` whenever rustc executes the linker, allowing us to define a `WasmLd` linker which implements the interface that `wasm-ld`, LLD's frontend, expects. Like Emscripten the LLD target is currently only enabled for Tier 1 platforms, notably OSX/Windows/Linux, and will need to be installed manually for compiling to wasm on other platforms. LLD is by default turned off in rustbuild, and requires a `config.toml` option to be enabled to turn it on. Finally the unstable `#![wasm_import_memory]` attribute was also removed as LLD has a native option for controlling this. [gc]: https://reviews.llvm.org/D42511
2018-03-01Fix link to rustc guide in README.mdTobias Stolzmann-1/+1
2018-02-23Start moving to the rustc guide!Mark Mansi-0/+4
2017-11-25Update MSVC compilation instructions regarding path length on WindowsBasile Desloges-0/+3
2017-10-14Add "Buidling on *nix" sub-headerJoe Rattazzi-0/+1
2017-10-09Clarify RAM usage during buildjohnthagen-1/+1
2017-09-29Add links to headers in README and CONTRIBUTING and dependencies to CONTRIBUTINGGarrett Berg-0/+12
2017-08-22Clarify windows build instructions in READMEMatt Ickstadt-1/+1
The old wording made me think you were supposed to do `python x.py --build=msvc`, which is not the case. Specify that you need to use the target triple.
2017-08-11Move config.toml.example to the root dirSteven Fackler-1/+1
It's way more discoverable here.
2017-07-03README: note how to enable debugging for rustcLee Bousfield-2/+3
2017-06-09Update TRPL link in README.mdFuqiao Xue-2/+2
2017-05-22rustbuild: split Install out of Dist subcommandMarc-Antoine Perennou-3/+3
only create source tarball for the Dist subcommand mark install rule as default for Kind::Install split install-docs split install-std factor out empty_dir handling split install-cargo split install-analysis split install-src rework install-rustc properly handle cross-compilation setups for install use pkgname in install split plain source tarball generation from rust-src dist document src-tarball in config.toml.exmaple Signed-off-by: Marc-Antoine Perennou <Marc-Antoine@Perennou.com>
2017-04-19Updated links to use httpsMaxwell Paul Brickner-2/+2
I just updated a few links to use https instead of http. Thank you! ^ _ ^
2017-03-21Nit: LLVM & Clang latest version is 4.0omtcyfz-1/+1
2017-03-13Updating README.md to point to the correct doc locationprojektir-2/+3
2017-03-06Fix text formatting in READMEMátyás Mustoha-1/+1
2017-02-28Replace ./configure with config.toml in README.md and CONTRIBUTING.mdJosh Driver-19/+40
2016-12-21Clarify phrasing of MSYS2 dependencies in README.md.Corey Farwell-2/+3
Fixes https://github.com/rust-lang/rust/issues/36115.
2016-12-07mk: Switch rustbuild to the default build systemAlex Crichton-33/+13
This commit switches the default build system for Rust from the makefiles to rustbuild. The rustbuild build system has been in development for almost a year now and has become quite mature over time. This commit is an implementation of the proposal on [internals] which slates deletion of the makefiles on 2016-01-02. [internals]: https://internals.rust-lang.org/t/proposal-for-promoting-rustbuild-to-official-status/4368 This commit also updates various documentation in `README.md`, `CONTRIBUTING.md`, `src/bootstrap/README.md`, and throughout the source code of rustbuild itself. Closes #37858
2016-11-02rustbuild: Rewrite user-facing interfaceAlex Crichton-2/+2
This commit is a rewrite of the user-facing interface to the rustbuild build system. The intention here is to make it much easier to compile/test the project without having to remember weird rule names and such. An overall view of the new interface is: # build everything ./x.py build # document everyting ./x.py doc # test everything ./x.py test # test libstd ./x.py test src/libstd # build libcore stage0 ./x.py build src/libcore --stage 0 # run stage1 run-pass tests ./x.py test src/test/run-pass --stage 1 The `src/bootstrap/bootstrap.py` script is now aliased as a top-level `x.py` script. This `x` was chosen to be both short and easily tab-completable (no collisions in that namespace!). The build system now accepts a "subcommand" of what to do next, the main ones being build/doc/test. Each subcommand then receives an optional list of arguments. These arguments are paths in the source repo of what to work with. That is, if you want to test a directory, you just pass that directory as an argument. The purpose of this rewrite is to do away with all of the arcane renames like "rpass" is the "run-pass" suite, "cfail" is the "compile-fail" suite, etc. By simply working with directories and files it's much more intuitive of how to run a test (just pass it as an argument). The rustbuild step/dependency management was also rewritten along the way to make this easy to work with and define, but that's largely just a refactoring of what was there before. The *intention* is that this support is extended for arbitrary files (e.g. `src/test/run-pass/my-test-case.rs`), but that isn't quite implemented just yet. Instead directories work for now but we can follow up with stricter path filtering logic to plumb through all the arguments.
2016-10-13add (missing) tar to list of packages to get under mingwDanny Hua-0/+1
2016-09-01README.md: fix a "\" in table heading to be "/"c4rlo-1/+1
2016-08-16Update minimum CMake version in READMENeil Williams-1/+1
The minimum got bumped in the LLVM upgrade of #34743.
2016-07-07Clarify rustbuild + msvc + vcvars in READMEAlex Crichton-8/+20
The invocation of vcvars is only needed for versions of Visual Studio that rustbuild or cmake doesn't understand, but if older versions are installed then there's no need to call vcvars. Closes #34576
2016-07-03Auto merge of #34504 - retep998:patch-1, r=alexcrichtonbors-5/+19
Instructions on how to build Rust with rustbuild This is a much simpler option for those on Windows who use msvc.
2016-07-02Instructions on how to build Rust with rustbuildPeter Atashian-5/+19
This is a much simpler option for those on Windows who use msvc. Signed-off-by: Peter Atashian <retep998@gmail.com>
2016-07-02Auto merge of #34611 - Manishearth:rollup, r=Manishearthbors-1/+1
Rollup of 7 pull requests - Successful merges: #34531, #34545, #34551, #34566, #34567, #34574, #34583 - Failed merges:
2016-06-30Fix README.md command consistencyJoachim Viide-1/+1
The ./configure command in README.md's Building Documentation section was missing the $ prefix. Add the prefix to be consistent with other commands in the document.
2016-06-27configure: Check for valid Python on MinGW as wellAlex Crichton-22/+22
The LLVM build system is somewhat picky about which Python is used to build it as it's known to be incompatible with the default `python2` package that ships with MinGW. This was previously detected for MSVC builds but the logic was left out for MinGW by accident (now that we've switched to cmake builds for LLVM everywhere). This corrects the `./configure` check and also updates the `README.md` accordingly. Additionally, a number of instructions were updated to work with the most recent copy of MSYS2. Closes #34489
2016-06-21Convert makefiles to build LLVM/compiler-rt with CMakeBrian Anderson-0/+1
2016-06-10Rollup merge of #34184 - euclio:patch-1, r=steveklabnikSeo Sanghyeon-6/+6
fix indentation in README
2016-06-09fix indentation in READMEAndy Russell-6/+6
2016-06-08Updated README to account for changes in MSYS2Morten H. Solvang-0/+2
One of the newest versions of MSYS2 now only has one .cmd file which replaces the old bat files. It has to be used to launch the mingw32/64 shell.
2016-04-30Note that later versions of G++ are okayDemetri Obenour-1/+1
G++ 4.7 is the minimum requirement, but later versions are also okay.
2016-03-31Adding #rust-beginners to README and pointing the two channels on ↵David AO Lozano-1/+2
getting-started
2016-03-20Correct Windows build instructions in README.mdVadim Petrochenkov-1/+1
http://mingw-w64.org/doku.php/download/mingw-builds now provides GCC 5.x as a default version, but avoiding 5.x is exactly the reason why Mingw-builds is recommended instead of MSYS2's own mingw toolchain. One of the 4.9.x versions has to manually chosen during installation.
2016-03-05Add note about avoiding spaces in MinGW install pathJohn Talling-1/+1
Using spaces in the install path causes the issue in #31293.