diff --git a/README.md b/README.md index 29e6504..ee472dc 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,10 @@ running `make docker`. ### Automatic Documentation Run `make docs` to create the documentation in the `docs` folder, which is based on -your docstrings in your code. You can view this by running `make view-docs`. +your docstrings in your code. You can publish this documentation to Github Pages by +running `make publish-docs`. To add more manual documentation pages, simply add more +Markdown files to the `docs` directory; this will automatically be included in the +documentation. ### Automatic Test Coverage Calculation diff --git a/{{cookiecutter.project_name}}/README.md b/{{cookiecutter.project_name}}/README.md index 2701066..8108659 100644 --- a/{{cookiecutter.project_name}}/README.md +++ b/{{cookiecutter.project_name}}/README.md @@ -114,7 +114,9 @@ running `make docker`. Run `make docs` to create the documentation in the `docs` folder, which is based on your docstrings in your code. You can publish this documentation to Github Pages by -running `make publish-docs`. +running `make publish-docs`. To add more manual documentation pages, simply add more +Markdown files to the `docs` directory; this will automatically be included in the +documentation. ### Automatic Test Coverage Calculation