File tree 1 file changed +15
-5
lines changed
1 file changed +15
-5
lines changed Original file line number Diff line number Diff line change @@ -19,22 +19,22 @@ order to write correct Unsafe Rust programs. Due to the nature of this problem,
19
19
it may lead to unleashing untold horrors that shatter your psyche into a billion
20
20
infinitesimal fragments of despair.
21
21
22
- ### Requirements
22
+ ## Requirements
23
23
24
24
Building the Nomicon requires [ mdBook] . To get it:
25
25
26
26
[ mdBook ] : https://github.com/rust-lang/mdBook
27
27
28
28
``` bash
29
- $ cargo install mdbook
29
+ cargo install mdbook
30
30
```
31
31
32
32
### ` mdbook ` usage
33
33
34
34
To build the Nomicon use the ` build ` sub-command:
35
35
36
36
``` bash
37
- $ mdbook build
37
+ mdbook build
38
38
```
39
39
40
40
The output will be placed in the ` book ` subdirectory. To check it out, open the
@@ -43,13 +43,23 @@ build` and it'll open the index page in your default browser (if the process is
43
43
successful) just like with ` cargo doc --open ` :
44
44
45
45
``` bash
46
- $ mdbook build --open
46
+ mdbook build --open
47
47
```
48
48
49
49
There is also a ` test ` sub-command to test all code samples contained in the book:
50
50
51
51
``` bash
52
- $ mdbook test
52
+ mdbook test
53
+ ```
54
+
55
+ ### ` linkcheck `
56
+
57
+ We use the ` linkcheck ` tool to find broken links.
58
+ To run it locally:
59
+
60
+ ``` sh
61
+ curl -sSLo linkcheck.sh https://raw.githubusercontent.com/rust-lang/rust/master/src/tools/linkchecker/linkcheck.sh
62
+ sh linkcheck.sh --all nomicon
53
63
```
54
64
55
65
## Contributing
You can’t perform that action at this time.
0 commit comments