From c2bcb3a93e1c2472b008bf7f4fb94e49c20d97e3 Mon Sep 17 00:00:00 2001 From: Anmol Sethi Date: Wed, 7 Dec 2022 19:30:04 -0800 Subject: [PATCH] release/template/README.md: Document easiest way to use windows --- ci/release/template/README.md.sh | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/ci/release/template/README.md.sh b/ci/release/template/README.md.sh index 99411d923..115bba209 100755 --- a/ci/release/template/README.md.sh +++ b/ci/release/template/README.md.sh @@ -19,14 +19,18 @@ ensure_os if [ "$OS" = windows ]; then cat < + +You can install on Windows with [MSYS2](https://www.msys2.org/) which emulates a Linux +shell for Windows. It also enables d2 to show colors in its output. But if you must install on Windows without MSYS2, for now you'll have to add the d2 binary -in \`./bin/d2.exe\` to your \`\$PATH\` manually. You can also add the \`./bin\` directory -to your \`\$PATH\`. +in \`./bin/d2.exe\` to your \`\$PATH\` manually. Or you can add the \`./bin\` directory to +your \`\$PATH\`. See https://www.wikihow.com/Change-the-PATH-Environment-Variable-on-Windows See https://github.com/terrastruct/d2/blob/master/docs/INSTALL.md#windows