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

release/README.md: Update Windows template to reflect .msi installer

Browse source
This commit is contained in:
Anmol Sethi 2022-12-18 11:49:22 -08:00
parent 72c0b76a22
commit 84d732f804
No known key found for this signature in database
GPG key ID: 25BC68888A99A8BA
1 changed files with 2 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -20,27 +20,11 @@ EOF
if [ "$OS" = windows ]; then if [ "$OS" = windows ]; then
cat <<EOF cat <<EOF
We currently do not have an \`.msi\` for automatic installation on Windows so this release This release is structured the same as our Unix releases for use with MSYS2.
is structured the same as our Unix releases.
Easiest way to use \`d2\` on Windows is to just \`chdir\` into the bin directory of this release You may find our \`.msi\` installer more convenient as it handles putting \`d2.exe\` into
and invoke \`d2\` like \`./d2 <full-input-file-path>\`
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\`.
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.exe\` into
your \`\$PATH\` for you. 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
with \`man d2\`.
See https://github.com/terrastruct/d2/blob/master/docs/INSTALL.md#windows See https://github.com/terrastruct/d2/blob/master/docs/INSTALL.md#windows
EOF EOF
fi fi