INSTALL.md: Note advantage of build.sh --install over go install
This commit is contained in:
parent
030f95441d
commit
25e9be5fde
2 changed files with 11 additions and 0 deletions
|
|
@ -104,6 +104,9 @@ Or if you have Go installed you can install from source though you won't get the
|
||||||
go install oss.terrastruct.com/d2@latest
|
go install oss.terrastruct.com/d2@latest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
You can also install a release from source which will include manpages.
|
||||||
|
See [./docs/INSTALL.md#source-release](./docs/INSTALL.md#source-release).
|
||||||
|
|
||||||
To uninstall with the install script:
|
To uninstall with the install script:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
|
|
|
||||||
|
|
@ -10,6 +10,7 @@ You may install `d2` through any of the following methods.
|
||||||
- <a href="#manual" id="toc-manual">Manual</a>
|
- <a href="#manual" id="toc-manual">Manual</a>
|
||||||
- <a href="#prefix" id="toc-prefix">PREFIX</a>
|
- <a href="#prefix" id="toc-prefix">PREFIX</a>
|
||||||
- <a href="#from-source" id="toc-from-source">From source</a>
|
- <a href="#from-source" id="toc-from-source">From source</a>
|
||||||
|
- <a href="#source-release" id="toc-source-release">Source Release</a>
|
||||||
- <a href="#coming-soon" id="toc-coming-soon">Coming soon</a>
|
- <a href="#coming-soon" id="toc-coming-soon">Coming soon</a>
|
||||||
|
|
||||||
## install.sh
|
## install.sh
|
||||||
|
|
@ -134,6 +135,8 @@ You can always install from source:
|
||||||
go install oss.terrastruct.com/d2@latest
|
go install oss.terrastruct.com/d2@latest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Source Release
|
||||||
|
|
||||||
To install a proper release from source clone the repository and then:
|
To install a proper release from source clone the repository and then:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
|
|
@ -142,6 +145,11 @@ To install a proper release from source clone the repository and then:
|
||||||
# ./ci/release/build.sh --uninstall
|
# ./ci/release/build.sh --uninstall
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Installing a real release will also install manpages and in the future other assets like
|
||||||
|
fonts and icons. Furthermore, when installing a non versioned commit, installing a proper
|
||||||
|
release will ensure that `d2 --version` works correctly by embedding the commit hash into
|
||||||
|
the `d2` binary.
|
||||||
|
|
||||||
## Coming soon
|
## Coming soon
|
||||||
|
|
||||||
- Docker image
|
- Docker image
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue