diff --git a/ci/release/template/README.md.sh b/ci/release/template/README.md.sh index 115bba209..6bfcfdb50 100755 --- a/ci/release/template/README.md.sh +++ b/ci/release/template/README.md.sh @@ -23,7 +23,7 @@ We currently do not have a .msi for automatic installation on Windows so this re structured the same as our Unix releases. Easiest way to use d2 on Windows is to just cd into the bin directory of this release -and invoke d2 like ./d2.exe +and invoke d2 like \`./d2.exe \` 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. @@ -32,6 +32,9 @@ But if you must install on Windows without MSYS2, for now you'll have to add the in \`./bin/d2.exe\` to your \`\$PATH\` manually. Or you can add the \`./bin\` directory to your \`\$PATH\`. +We intend to have a \`.msi\` release installer sometime soon that handles putting \`d2\` into +your \`\$PATH\` for you. + See https://www.wikihow.com/Change-the-PATH-Environment-Variable-on-Windows See https://github.com/terrastruct/d2/blob/master/docs/INSTALL.md#windows EOF diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 7d29525d2..c4c0b7cd4 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -158,8 +158,13 @@ the `d2` binary. d2 builds and runs on Windows: We have prebuilt standalone releases for Windows though they're structured in the same way -as our Unix releases. So after extracting a release, you'll have to manually put the d2 -binary into your `$PATH` or add the `bin` directory of the release into your `$PATH`. +as our Unix releases. + +Easiest way to use d2 on Windows is to just cd into the bin directory of the release after +extracting it and invoking d2 like `./d2.exe ` + +For installation, you'll have to manually put the d2 binary into your `$PATH` or add the +`bin` directory of the release into your `$PATH`. See https://www.wikihow.com/Change-the-PATH-Environment-Variable-on-Windows