From d1895cd12638dc4278e5ee763709c212599a262a Mon Sep 17 00:00:00 2001 From: dpedu Date: Fri, 19 Jun 2015 21:09:43 -0700 Subject: [PATCH] Update readmes --- README.md | 3 +++ docs/builder/README.md | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cb1032a..54bd2e8 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,9 @@ Building Docs Or, use my pre-built copy [here](http://davepedu.com/files/botdocs/). +Alternatively, use the included Dockerfile to create an environment for +building the docs. Check `docs/builder/README.md`. + Developing Modules ------------------ diff --git a/docs/builder/README.md b/docs/builder/README.md index c572fd0..b38bcf8 100644 --- a/docs/builder/README.md +++ b/docs/builder/README.md @@ -5,5 +5,5 @@ A docker image for building pyircbot's docs. **Usage:** -* Create image: `cd docs/builder ; docker build -t pybdocbuilder . +* Create image: `cd docs/builder ; docker build -t pybdocbuilder .` * Build docs: `docker run --rm -v /local/path/to/doc/output/:/tmp/docs/ pybdocbuilder /start`