luciano/d2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

release/template/README.md: Document easiest way to use windows

Browse source
This commit is contained in:
Anmol Sethi 2022-12-07 19:30:04 -08:00
parent 1fde26789a
commit c2bcb3a93e
No known key found for this signature in database
GPG key ID: 25BC68888A99A8BA
1 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
ci/release/template/README.md.sh
View file

@ -19,14 +19,18 @@ ensure_os
if [ "$OS" = windows ]; then
cat <<EOF
We currently do not have a .msi for proper installation on Windows so this release is
structured the same as our Unix releases. You can still install on Windows still though
with [MSYS2](https://www.msys2.org/) which emulates a Linux shell for Windows. It also
enables d2 to show colors in its output.
We currently do not have a .msi for automatic installation on Windows so this release is
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 <full-input-file-path>
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