diff --git a/ci/release/template/README.md.sh b/ci/release/template/README.md.sh index d52d96716..7ccea6fb2 100755 --- a/ci/release/template/README.md.sh +++ b/ci/release/template/README.md.sh @@ -3,6 +3,8 @@ set -eu cd -- "$(dirname "$0")/../../.." . ./ci/sub/lib.sh +ensure_os +ensure_arch cat <\` +Easiest way to use \`d2\` on Windows is to just \`chdir\` into the bin directory of this release +and invoke \`d2\` like \`./d2 \` For installation you'll have to add the \`./bin/d2.exe\` binary to your \`\$PATH\`. Or add the \`./bin\` directory of this release to your \`\$PATH\`. @@ -32,12 +33,12 @@ See https://www.wikihow.com/Change-the-PATH-Environment-Variable-on-Windows Then you'll be able to call \`d2\` from the commandline in \`cmd.exe\` or \`pwsh.exe\`. -We intend to have a \`.msi\` release installer sometime soon that handles putting \`d2\` into +We intend to have a \`.msi\` release installer sometime soon that handles putting \`d2.exe\` into your \`\$PATH\` for you. You can also use \`make install\` to install on Windows after first installing [MSYS2](https://www.msys2.org/) which emulates a Linux shell for Windows. Its terminal -also enables d2 to show colors in its output. The manpage will also become accessible +also enables \`d2\` to show colors in its output. The manpage will also become accessible with \`man d2\`. See https://github.com/terrastruct/d2/blob/master/docs/INSTALL.md#windows