diff --git a/README.md b/README.md index 36e20ec24..d9f6e4fe4 100644 --- a/README.md +++ b/README.md @@ -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 ``` +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: ```sh diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 3238211aa..86b7e7bad 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -10,6 +10,7 @@ You may install `d2` through any of the following methods. - Manual - PREFIX - From source + - Source Release - Coming soon ## install.sh @@ -134,6 +135,8 @@ You can always install from source: go install oss.terrastruct.com/d2@latest ``` +### Source Release + To install a proper release from source clone the repository and then: ```sh @@ -142,6 +145,11 @@ To install a proper release from source clone the repository and then: # ./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 - Docker image