From 7b7996c9c12a434bf45a82ec0fc1785c4592dbaf Mon Sep 17 00:00:00 2001 From: Leonard Jonathan Oh Date: Sun, 30 Oct 2022 10:57:18 +0000 Subject: [PATCH] Docs (readme): Add Development section --- README.md | 14 ++++++++++++++ generate/README.md | 3 --- generate/templates/README.md.ps1 | 18 ++++++++++++++++++ 3 files changed, 32 insertions(+), 3 deletions(-) delete mode 100644 generate/README.md diff --git a/README.md b/README.md index 43f5457..ae567f7 100644 --- 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 deleted file mode 100644 index 800b84d..0000000 --- a/generate/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Files to generate the variants - -Powershell Module: [Generate-DockerImageVariants](https://github.com/leojonathanoh/generate-dockerimagevariants) diff --git a/generate/templates/README.md.ps1 b/generate/templates/README.md.ps1 index d51bb02..0d092af 100644 --- 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 . +``` + +'@