From d5932d2f98d62c5612dbeb71ba630b4f92c5347d Mon Sep 17 00:00:00 2001
From: Chris Krycho <hello@chriskrycho.com>
Date: Wed, 11 Sep 2024 17:22:59 -0600
Subject: [PATCH] Update build instructions: include mdbook plugins

Fixes #4018
---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

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 <version_num>
 ```
 
+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: