doc/INSTALL.md: Backquote d2
This commit is contained in:
parent
116151cc82
commit
9dede51973
1 changed files with 5 additions and 6 deletions
|
|
@ -1,6 +1,6 @@
|
|||
# install
|
||||
|
||||
You may install D2 through any of the following methods.
|
||||
You may install `d2` through any of the following methods.
|
||||
|
||||
<!-- toc -->
|
||||
- <a href="#installsh" id="toc-installsh">install.sh</a>
|
||||
|
|
@ -43,22 +43,21 @@ the install script is more vulnerable to than any other method of manual install
|
|||
The most secure installation method involves a second independent entity, i.e your OS
|
||||
package repos or Go's proxy server.
|
||||
|
||||
We're careful shell programmers and are aware of the many footguns of the unix shell. Our
|
||||
We're careful shell programmers and are aware of the many footguns of the Unix shell. Our
|
||||
script was written carefully and with detail. For example, it is not vulnerable to partial
|
||||
execution and the entire script runs with `set -eu` and very meticulous quoting.
|
||||
|
||||
It follows the XDG standards, installs d2 properly into a unix hierarchy path (defaulting
|
||||
It follows the XDG standards, installs `d2` properly into a Unix hierarchy path (defaulting
|
||||
to /usr/local though you can use ~/.local to avoid sudo if you'd like) and allows for easy
|
||||
uninstall.
|
||||
|
||||
Some other niceties are that it'll tell you if you need to adjust `$PATH` or `$MANPATH` to
|
||||
access d2 and its manpages. It can also install
|
||||
access `d2` and its manpages. It can also install
|
||||
[TALA](https://github.com/terrastruct/tala) for you with `--tala`. You can also use it to
|
||||
install a specific version of `d2` with `--version`. Run it with `--help` for more more
|
||||
detailed docs on its various options and features.
|
||||
|
||||
If you're still concerned, remember you can run with `--dry-run` to avoid executing
|
||||
anything permanent.
|
||||
If you're still concerned, remember you can run with `--dry-run` to avoid writing anything.
|
||||
|
||||
The install script does not yet verify any signature on the downloaded release
|
||||
but that is coming soon. [#315](https://github.com/terrastruct/d2/issues/315)
|
||||
|
|
|
|||
Loading…
Reference in a new issue