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

some changes

Browse source
This commit is contained in:
Anmol Sethi 2022-11-21 16:35:27 -08:00
parent 80136a2a11
commit 519ee03b3c
No known key found for this signature in database
GPG key ID: 25BC68888A99A8BA
1 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/INSTALL.md
View file

@ -33,17 +33,19 @@ curl -fsSL https://d2lang.com/install.sh | sh -s -- --help
## macOS (Homebrew) ## macOS (Homebrew)
If you're on macOS, you can alternatively install with `brew`. (the install script above If you're on macOS, you can alternatively install with `brew`.
does this automatically if you have `brew` installed).
```sh ```sh
brew tap terrastruct/d2 brew tap terrastruct/d2
brew install d2 brew install d2
``` ```
> The install script above does this automatically if you have `brew` installed and
> are running it on macOS.
## Standalone ## Standalone
We publish standalone release archives with every release on Github. We publish standalone release archives for every release on Github.
Download the `.tar.gz` release for your OS/ARCH combination and then run the following Download the `.tar.gz` release for your OS/ARCH combination and then run the following
inside the extracted directory to install: inside the extracted directory to install:
@ -57,7 +59,7 @@ Run the following to uninstall:
make uninstall make uninstall
``` ```
You will be prompted for sudo/su/doas if root permissions are required for installation. If root permissions are required for installation, you'll need to run `make` with `sudo`.
You can control the Unix hierarchy installation path with `PREFIX=`. For example: You can control the Unix hierarchy installation path with `PREFIX=`. For example:
``` ```
@ -72,12 +74,13 @@ The install script places the standalone release into `$PREFIX/lib/d2/d2-<versio
and we recommend doing the same with manually installed releases so that you and we recommend doing the same with manually installed releases so that you
know where the release directory is for easy uninstall. know where the release directory is for easy uninstall.
> warn: Our binary releases aren't fully portable like normal Go binaries due to the C > warn: Our binary releases aren't fully static like normal Go binaries due to the C
> dependency on v8go for executing dagre. > dependency on v8go for executing dagre. If you're on an older system with an old
> libc, you'll want to install from source.
## From source ## From source
Alternatively, you can always install from source: You can always install from source:
```sh ```sh
go install oss.terrastruct.com/d2/cmd/d2@latest go install oss.terrastruct.com/d2/cmd/d2@latest
@ -88,4 +91,5 @@ go install oss.terrastruct.com/d2/cmd/d2@latest
- Docker image - Docker image
- Windows install - Windows install
- rpm and deb packages - rpm and deb packages
- with repositories and standalone
- homebrew core - homebrew core