X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=ac39435a8c7fb9338a0f278452e2d8ff8afa525d;hb=481725984b4cd94ef5c00917b01c1771b6e5299c;hp=c9dc9cc0a7338f9a1418e3048c4471def8001762;hpb=a3cf58533fbfe03f770579a30acbcda3d30e2567;p=rust.git diff --git a/README.md b/README.md index c9dc9cc0a73..ac39435a8c7 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ standard library, and documentation. [Rust]: https://www.rust-lang.org -**Note**: this README is for _users_ rather than _contributors_. +**Note: this README is for _users_ rather than _contributors_.** If you wish to _contribute_ to the compiler, you should read [CONTRIBUTING.md](CONTRIBUTING.md) instead. ## Quick Start @@ -20,22 +20,23 @@ Read ["Installation"] from [The Book]. The Rust build system uses a Python script called `x.py` to build the compiler, which manages the bootstrapping process. It lives at the root of the project. -The `x.py` command can be run directly on most systems in the following format: +The `x.py` command can be run directly on most Unix systems in the following format: ```sh ./x.py [flags] ``` -This is how the documentation and examples assume you are running `x.py`. - -Systems such as Ubuntu 20.04 LTS do not create the necessary `python` command by default when Python is installed that allows `x.py` to be run directly. In that case, you can either create a symlink for `python` (Ubuntu provides the `python-is-python3` package for this), or run `x.py` using Python itself: +This is how the documentation and examples assume you are running `x.py`. Some alternative ways are: ```sh -# Python 3 -python3 x.py [flags] +# On a Unix shell if you don't have the necessary `python3` command +./x [flags] + +# On the Windows Command Prompt (if .py files are configured to run Python) +x.py [flags] -# Python 2.7 -python2.7 x.py [flags] +# You can also run Python yourself, e.g.: +python x.py [flags] ``` More information about `x.py` can be found