aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGabriel Nagy <gabriel.nagy@puppet.com>2020-05-06 15:31:40 +0300
committerGabriel Nagy <gabriel.nagy@puppet.com>2020-05-06 15:31:40 +0300
commit2dcf54a08eb666b480d7888c953e5e47e706f73f (patch)
tree73f1f871168fa76b33b0d2826a31539dea59fd50 /README.md
parent25907b9cef858619339b8d94f6270eb12f9c57e0 (diff)
downloadpuppet-cron_core-2dcf54a08eb666b480d7888c953e5e47e706f73f.tar.gz
puppet-cron_core-2dcf54a08eb666b480d7888c953e5e47e706f73f.tar.bz2
(maint) Update README.md
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.