1
0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-11-06 09:29:26 +02:00

Add more prominent references to cargo xtask (#2904)

I found that Gemini didn’t know how to install the necessary tools
make `dprint fmt` work, so I’m adding more references to `cargo xtask`
in our documentation.
This commit is contained in:
Martin Geisler
2025-09-20 13:15:28 +02:00
committed by GitHub
parent f4a11a4fc5
commit 80a2f2ff71
3 changed files with 13 additions and 6 deletions

View File

@@ -65,15 +65,15 @@ git clone https://github.com/google/comprehensive-rust/
cd comprehensive-rust
```
Then install these tools with:
Then run the following command to install the correct versions of all tools
mentioned above:
```shell
cargo xtask install-tools
```
> **Note** We use `xtask` for task automation within the project (e.g.
> installing required tools). Xtask is not a package that you should install.
> Visit https://github.com/matklad/cargo-xtask for more information.
This uses `cargo install` to install the tools, so you will find them in your
`~/.cargo/bin/` directory afterwards.
## Commands