From 9bf4036d17eccc9d39d1ef64f7f3f0b68fb3dfdc Mon Sep 17 00:00:00 2001 From: KaDiWa Date: Mon, 26 Dec 2022 00:33:32 +0100 Subject: readme: update section on how to run x.py --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) (limited to 'README.md') 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 [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 -- cgit v1.2.1