From 36f16e5f8666c92ebf6ae8d10c34201fed9e6bf6 Mon Sep 17 00:00:00 2001 From: ciatph Date: Thu, 12 Sep 2024 23:00:35 +0800 Subject: [PATCH] docs: README * indicate docs:install/build compatibility for docker only --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5596475..1a01d7d 100644 --- a/README.md +++ b/README.md @@ -205,10 +205,10 @@ Builds the class documentation into the **/docs** directory. ### `npm run docs:install` -Runs the Bash script that installs the JSDoc and theme dependencies for building the class documentation. +Runs the Bash script that installs the JSDoc and theme dependencies for building the class documentation within athe development Docker environment. > [!NOTE] -> This script requires running from a Bash terminal: it won't work from a Windows command line terminal. +> This script requires running from a Bash terminal - it won't work from a Windows command line terminal. It is reserved for building the documentation with Docker. This script is used for building the class documentation from a local Docker environment along with the `npm run docs:build` NPM script. @@ -219,10 +219,10 @@ docker exec -u root -it ph-municipalities npm run docs:build ### `npm run docs:build` -Runs the Bash script that builds the class documentation using JSDoc. +Runs the Bash script that builds the class documentation using JSDoc within athe development Docker environment. > [!NOTE] -> This script requires running from a Bash terminal: it won't work from a Windows command line terminal. +> This script requires running from a Bash terminal - it won't work from a Windows command line terminal. It is reserved for building the documentation with Docker. This script is used for building the class documentation from a local Docker environment along with the `npm run docs:install` NPM script.