Merge pull request #22 from theohbrothers/docs/readme-add-development…

…-section Docs (readme): Add Development section
theohbrothers · Oct 30, 2022 · 05a3b41 · 05a3b41
2 parents c4e7dc1 + 7b7996c
commit 05a3b41
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -32,3 +32,17 @@ Dockerized `powershell`, based on [mcr.microsoft.com/powershell](https://hub.doc
 | `:6.1.3-ubuntu-18.04-git-sops` | [View](variants/6.1.3-ubuntu-18.04-git-sops ) |
 | `:6.0.2-ubuntu-16.04` | [View](variants/6.0.2-ubuntu-16.04 ) |
 | `:6.0.2-ubuntu-16.04-git-sops` | [View](variants/6.0.2-ubuntu-16.04-git-sops ) |
+
+## Development
+
+Requires Windows `powershell` or [`pwsh`](https://github.com/PowerShell/PowerShell).
+
+```powershell
+# Install Generate-DockerImageVariants module: https://github.com/theohbrothers/Generate-DockerImageVariants
+Install-Module -Name Generate-DockerImageVariants -Repository PSGallery -Scope CurrentUser -Force -Verbose
+
+# Edit ./generate templates
+
+# Generate the variants
+Generate-DockerImageVariants .
+```
diff --git a/generate/README.md b/generate/README.md
diff --git a/generate/templates/README.md.ps1 b/generate/templates/README.md.ps1
@@ -26,4 +26,22 @@ $(
     }
 }) -join ''
 )
+
 "@
+
+@'
+## Development
+
+Requires Windows `powershell` or [`pwsh`](https://github.com/PowerShell/PowerShell).
+
+```powershell
+# Install Generate-DockerImageVariants module: https://github.com/theohbrothers/Generate-DockerImageVariants
+Install-Module -Name Generate-DockerImageVariants -Repository PSGallery -Scope CurrentUser -Force -Verbose
+
+# Edit ./generate templates
+
+# Generate the variants
+Generate-DockerImageVariants .
+```
+
+'@