From b6105db8dcf1e3e6a57cfc6f189e961be86335f0 Mon Sep 17 00:00:00 2001
From: Michael Bryan <michaelfbryan@gmail.com>
Date: Sat, 27 Jan 2018 14:53:46 +0800
Subject: [PATCH] Added a note about how to use mdbook-linkcheck

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 5ff51de2..352c4ce0 100644
--- a/README.md
+++ b/README.md
@@ -25,3 +25,11 @@ for you to talk with someone who **does** know the code, or who wants
 to pair with you and figure it out.  Then you can work on writing up
 what you learned.
 
+To help prevent accidentally introducing broken links, we use the
+`mdbook-linkcheck`. If installed on your machine `mdbook` will automatically
+invoke this link checker, otherwise it will emit a warning saying it couldn't
+be found.
+
+```
+$ cargo install mdbook-linkcheck
+```