aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7aed631..3460895 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,7 @@ To generate documentation locally, run the following command:
```
bundle install
-bundle exec puppet strings generate ./lib/**/*.rb
+bundle exec puppet strings generate --format markdown --out REFERENCE.md
```
This command will create a browsable \_index.html file in the doc directory. The references available here are all generated from YARD-style comments embedded in the code base. When any development happens on this module, the impacted documentation should also be updated.