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

install.md: Document easiest way to use windows

Browse source
This commit is contained in:
Anmol Sethi 2022-12-07 19:32:26 -08:00
parent c2bcb3a93e
commit 3134648273
No known key found for this signature in database
GPG key ID: 25BC68888A99A8BA
2 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -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 <full-input-file-path>
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.
@ -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

9
docs/INSTALL.md
View file

@ -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 <full-input-file-path>`
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