From d89f2f8834608feae89901d145392c9ca45b6705 Mon Sep 17 00:00:00 2001 From: Romain Lesur Date: Thu, 16 Jun 2022 14:51:59 +0200 Subject: [PATCH 1/2] explain how to update the documentation --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index dfe1760..291fbfe 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,13 @@ you. will know what to expect. You may also want to update the URLs above to match your repository. +4. [ ] **Build the documentation**: this template provides a + [tool][doc generator] to build an HTML documentation. Execute + `make docs` to update the documentation. The documentation website + files are located in the `docs` folder. + +[doc generator]: ./.tools/docs.lua + License ------------------------------------------------------------------ From 524c7fffe13c47433a9283fd69d5bb57f140333e Mon Sep 17 00:00:00 2001 From: Romain Lesur Date: Thu, 16 Jun 2022 15:18:36 +0200 Subject: [PATCH 2/2] reference GitHub Pages documentation --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 291fbfe..2f3f8f8 100644 --- a/README.md +++ b/README.md @@ -39,12 +39,15 @@ you. will know what to expect. You may also want to update the URLs above to match your repository. -4. [ ] **Build the documentation**: this template provides a - [tool][doc generator] to build an HTML documentation. Execute +4. [ ] **Build and serve the documentation**: this template provides + a [tool][doc generator] to build an HTML documentation. Execute `make docs` to update the documentation. The documentation website - files are located in the `docs` folder. + files are located in the `docs` folder and can be published with + GitHub Pages (see the GitHub documentation on + [configuring GitHub Pages][GitHub Pages]). [doc generator]: ./.tools/docs.lua +[GitHub Pages]: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site License ------------------------------------------------------------------