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

docs/INSTALL.md: Document msi installer

Browse source 
Closes #379
This commit is contained in:
Anmol Sethi 2022-12-18 10:18:23 -08:00
parent 4495504102
commit e3e889f90d
No known key found for this signature in database
GPG key ID: 25BC68888A99A8BA
2 changed files with 10 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
ci/release/changelogs/next.md
View file

@ -3,10 +3,11 @@
- Diagram padding can now can be configured in the CLI (default 100px). [https://github.com/terrastruct/d2/pull/431](https://github.com/terrastruct/d2/pull/431) - Diagram padding can now can be configured in the CLI (default 100px). [https://github.com/terrastruct/d2/pull/431](https://github.com/terrastruct/d2/pull/431)
- Connection label backgrounds can now be set with the `style.fill` keyword. [https://github.com/terrastruct/d2/pull/452](https://github.com/terrastruct/d2/pull/452) - Connection label backgrounds can now be set with the `style.fill` keyword. [https://github.com/terrastruct/d2/pull/452](https://github.com/terrastruct/d2/pull/452)
- Add official Docker image. See [./docs/INSTALL.md#docker](./docs/INSTALL.md#docker). [#76](https://github.com/terrastruct/d2/issues/76) - Add official Docker image. See [./docs/INSTALL.md#docker](./docs/INSTALL.md#docker). [#76](https://github.com/terrastruct/d2/issues/76)
- Add `.msi` installer for convenient installation on Windows. [#379](https://github.com/terrastruct/d2/issues/379)
#### Improvements 🧹 #### Improvements 🧹
- Fmt now preserves leading comment spacing. - `d2 fmt` now preserves leading comment spacing.
[#400](https://github.com/terrastruct/d2/issues/400) [#400](https://github.com/terrastruct/d2/issues/400)
#### Bugfixes ⛑️ #### Bugfixes ⛑️

28
docs/INSTALL.md
View file

@ -175,31 +175,19 @@ binary.
## Windows ## Windows
d2 builds and runs on Windows: We have prebuilt releases of d2 available for Windows via `.msi` installers. The installer
will add the `d2` binary to your `$PATH` so that you can execute `d2` in `cmd.exe` or
`pwsh.exe`.
We have prebuilt standalone releases for Windows though they're structured in the same way ### Release archives
as our Unix releases.
Easiest way to use d2 on Windows is to just `chdir` into the bin directory of the release We also have release archives for Windows structured in the same way as our Unix releases
and invoke d2 like `./d2 <full-input-file-path>` for use with MSYS2.
For installation, you'll have to put the `bin/d2.exe` 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
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
your `$PATH` for you.
### MSYS2
<img width="1680" alt="Screenshot 2022-12-06 at 2 55 27 AM" src="https://user-images.githubusercontent.com/10180857/205892927-6f3e116c-1c4a-440a-9972-82c306aa9779.png"> <img width="1680" alt="Screenshot 2022-12-06 at 2 55 27 AM" src="https://user-images.githubusercontent.com/10180857/205892927-6f3e116c-1c4a-440a-9972-82c306aa9779.png">
We recommend using [MSYS2](https://www.msys2.org/) or [Git See [MSYS2](https://www.msys2.org/) or [Git Bash](https://gitforwindows.org/#bash) (Git
Bash](https://gitforwindows.org/#bash) (Git Bash is based on MSYS2) for an improved Bash is based on MSYS2).
terminal experience.
MSYS2 provides a unix style shell environment that is native to Windows (unlike MSYS2 provides a unix style shell environment that is native to Windows (unlike
[Cygwin](https://www.cygwin.com/)). MSYS2 allows `install.sh` to work, enables automatic [Cygwin](https://www.cygwin.com/)). MSYS2 allows `install.sh` to work, enables automatic