diff --git a/README.md b/README.md index 78c00e6..6279f83 100644 --- a/README.md +++ b/README.md @@ -36,4 +36,7 @@ To see a current list of commands, run `make help`. `make docserver` will start a `yard` server using the RDoc comments from the codebase. RDoc in this application is a work-in-progress and should improve over time. As of this writing, the index page generated contains broken links to our markdown documentation, but they "files" navigation displays them properly. +> [!TIP] +> Prior to running `make docserver` the first time, you must install the bundled gems for this application using either `bundle install` or `make install` (they both do the same thing!). + [Class Diagram](docs/reference/classes.md)