summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKaDiWa <kalle.wachsmuth@gmail.com>2022-12-26 00:33:32 +0100
committerKaDiWa <kalle.wachsmuth@gmail.com>2022-12-26 00:33:32 +0100
commit9bf4036d17eccc9d39d1ef64f7f3f0b68fb3dfdc (patch)
tree7277e2a7818f46d03365a5e241790f15abf373a4 /README.md
parentd9ee0f468f8d07e92da94fe991db91e95822d721 (diff)
downloadrust-9bf4036d17eccc9d39d1ef64f7f3f0b68fb3dfdc.tar.gz
readme: update section on how to run x.py
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/README.md b/README.md
index 2b7edf2c3c9..ac39435a8c7 100644
--- a/README.md
+++ b/README.md
@@ -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 <subcommand> [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 <subcommand> [flags]
+# On a Unix shell if you don't have the necessary `python3` command
+./x <subcommand> [flags]
+
+# On the Windows Command Prompt (if .py files are configured to run Python)
+x.py <subcommand> [flags]
-# Python 2.7
-python2.7 x.py <subcommand> [flags]
+# You can also run Python yourself, e.g.:
+python x.py <subcommand> [flags]
```
More information about `x.py` can be found