File tree Expand file tree Collapse file tree 3 files changed +12
-7
lines changed Expand file tree Collapse file tree 3 files changed +12
-7
lines changed Original file line number Diff line number Diff line change 3
3
We'd love to accept your patches and contributions to this project. There are
4
4
just a few small guidelines you need to follow.
5
5
6
- Make sure you can build the book, and that ` mdbook serve ` works. Please follow
7
- the [ instructions in the README] .
6
+ Make sure you can build the book with ` mdbook build ` , that ` mdbook serve ` works,
7
+ and that ` dprint fmt ` formats the code. Please use ` cargo xtask install-tools `
8
+ to install the necessary dependencies, following the
9
+ [ instructions in the README] .
8
10
9
11
[ instructions in the README ] : README.md#building
10
12
Original file line number Diff line number Diff line change @@ -36,6 +36,8 @@ tests, and managing translations.
36
36
``` bash
37
37
cargo xtask install-tools
38
38
```
39
+ This is a necessary first step for working with this repository. It will
40
+ install the correct versions of all tools used by the project.
39
41
40
42
## Commands
41
43
@@ -73,7 +75,8 @@ list of options.
73
75
- ** Course Content:** Markdown files in the ` src/ ` directory, structured
74
76
according to ` src/SUMMARY.md ` .
75
77
- ** Code Formatting:** ` dprint fmt ` is used to format all source files according
76
- to ` rustfmt.toml ` and ` dprint.json ` .
78
+ to ` rustfmt.toml ` and ` dprint.json ` . Note that you must first install the
79
+ project tools with ` cargo xtask install-tools ` .
77
80
- ** Contributions:** Refer to ` CONTRIBUTING.md ` for guidelines on contributing
78
81
to the project.
79
82
- ** Style:** Refer to ` STYLE.md ` for style guidelines.
Original file line number Diff line number Diff line change @@ -65,15 +65,15 @@ git clone https://github.com/google/comprehensive-rust/
65
65
cd comprehensive-rust
66
66
```
67
67
68
- Then install these tools with:
68
+ Then run the following command to install the correct versions of all tools
69
+ mentioned above:
69
70
70
71
``` shell
71
72
cargo xtask install-tools
72
73
```
73
74
74
- > ** Note** We use ` xtask ` for task automation within the project (e.g.
75
- > installing required tools). Xtask is not a package that you should install.
76
- > Visit https://github.com/matklad/cargo-xtask for more information.
75
+ This uses ` cargo install ` to install the tools, so you will find them in your
76
+ ` ~/.cargo/bin/ ` directory afterwards.
77
77
78
78
## Commands
79
79
You can’t perform that action at this time.
0 commit comments