File tree 1 file changed +12
-5
lines changed
1 file changed +12
-5
lines changed Original file line number Diff line number Diff line change @@ -81,10 +81,17 @@ Correction and elaboration PRs are very welcome.
81
81
82
82
## Building with mdbook
83
83
84
- Install ` mdbook ` with the following command
84
+ This book is built with [ mdbook ] ( https://rust-lang.github.io/mdBook/ ) . You can install it by running ` cargo install mdbook ` .
85
85
86
- ` cargo install mdbook `
86
+ If you want to build it locally you can run one of these two commands in the root directory of the repository:
87
87
88
- and run ` mdbook build ` in the root directory of the repository. The standard
89
- output folder is ` /book ` . If you want to take a look in the browser you can
90
- use ` mdbook serve ` and open the corresponding address (take a look at the terminal output).
88
+ - ` mdbook build `
89
+
90
+ Builds static html pages as output and place them in the ` /book ` directory by default.
91
+
92
+ - ` mdbook serve `
93
+
94
+ Serves the book at ` http://localhost:3000 ` (port is changeable, take a look at the terminal output
95
+ to be sure) and reloads the browser when a change occurs.
96
+
97
+
You can’t perform that action at this time.
0 commit comments