diff --git a/README.md b/README.md index 8befc1b31e..9648db0ae0 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,16 @@ rust-lang/rust uses in [this file][rust-mdbook]. To get it: $ cargo install mdbook --locked --version ``` +The book also uses two mdbook plugins which are part of this repository. If you +do not install them, you will see warnings when building and the output will not +look right, but you *will* still be able to build the book. To use the plugins, +you should run: + +```bash +$ cargo install --locked --path packages/mdbook-trpl-listing +$ cargo install --locked --path packages/mdbook-trpl-note +``` + ## Building To build the book, type: