From 519ee03b3c7ab78e0635716337db2fe9d4667bf5 Mon Sep 17 00:00:00 2001 From: Anmol Sethi Date: Mon, 21 Nov 2022 16:35:27 -0800 Subject: [PATCH] some changes --- docs/INSTALL.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/INSTALL.md b/docs/INSTALL.md index cf6599adb..c094817b2 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -33,17 +33,19 @@ curl -fsSL https://d2lang.com/install.sh | sh -s -- --help ## macOS (Homebrew) -If you're on macOS, you can alternatively install with `brew`. (the install script above -does this automatically if you have `brew` installed). +If you're on macOS, you can alternatively install with `brew`. ```sh brew tap terrastruct/d2 brew install d2 ``` +> The install script above does this automatically if you have `brew` installed and +> are running it on macOS. + ## 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 inside the extracted directory to install: @@ -57,7 +59,7 @@ Run the following to 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: ``` @@ -72,12 +74,13 @@ The install script places the standalone release into `$PREFIX/lib/d2/d2- warn: Our binary releases aren't fully portable like normal Go binaries due to the C -> dependency on v8go for executing dagre. +> warn: Our binary releases aren't fully static like normal Go binaries due to the C +> 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 -Alternatively, you can always install from source: +You can always install from source: ```sh go install oss.terrastruct.com/d2/cmd/d2@latest @@ -88,4 +91,5 @@ go install oss.terrastruct.com/d2/cmd/d2@latest - Docker image - Windows install - rpm and deb packages + - with repositories and standalone - homebrew core