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.
This commit is contained in:
jyn 2023-06-24 11:17:06 -05:00
parent 69a63737fa
commit b556e28496

View File

@ -33,24 +33,13 @@ format:
``` ```
This is how the documentation and examples assume you are running `x.py`. This is how the documentation and examples assume you are running `x.py`.
Some alternative ways are: See the [rustc dev guide][rustcguidebuild] if this does not work on your platform.
```sh
# 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]
# You can also run Python yourself, e.g.:
python x.py <subcommand> [flags]
```
More information about `x.py` can be found by running it with the `--help` flag More information about `x.py` can be found by running it with the `--help` flag
or reading the [rustc dev guide][rustcguidebuild]. or reading the [rustc dev guide][rustcguidebuild].
[gettingstarted]: https://rustc-dev-guide.rust-lang.org/getting-started.html [gettingstarted]: https://rustc-dev-guide.rust-lang.org/getting-started.html
[rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html [rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html#what-is-xpy
### Dependencies ### Dependencies