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

releas/template: Minor fixes

Browse source
This commit is contained in:
Anmol Sethi 2022-12-08 02:32:09 -08:00
parent b0993c45b4
commit 87f811f538
No known key found for this signature in database
GPG key ID: 25BC68888A99A8BA
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -3,6 +3,8 @@ set -eu
cd -- "$(dirname "$0")/../../.." cd -- "$(dirname "$0")/../../.."
. ./ci/sub/lib.sh . ./ci/sub/lib.sh
ensure_os
ensure_arch
cat <<EOF cat <<EOF
# d2 # d2
@ -15,15 +17,14 @@ arch: $ARCH
Built with $(go version | grep -o 'go[^ ]\+'). Built with $(go version | grep -o 'go[^ ]\+').
EOF EOF
ensure_os
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 We currently do not have an \`.msi\` for automatic installation on Windows so this release
is structured the same as our Unix releases. 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 Easiest way to use \`d2\` on Windows is to just \`chdir\` into the bin directory of this release
and invoke d2 like \`./d2 <full-input-file-path>\` 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 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\`. 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\`. 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. your \`\$PATH\` for you.
You can also use \`make install\` to install on Windows after first installing 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 [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\`. 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