[ci-base] update readme

This commit is contained in:
Alexander Wang 2022-11-14 17:05:05 -08:00
parent 4c23fa7320
commit 7efa5ac113
No known key found for this signature in database
GPG key ID: D89FA31966BDBECE

View file

@ -20,10 +20,11 @@
<!-- toc --> <!-- toc -->
- [Quickstart (CLI)](#quickstart-cli) - [Quickstart](#quickstart)
- [Install](#install)
* [Install script](#install-script)
* [Install from source](#install-from-source) * [Install from source](#install-from-source)
* [Install](#install) - [D2 as a library](#d2-as-a-library)
- [Quickstart (library)](#quickstart-library)
- [Themes](#themes) - [Themes](#themes)
- [Fonts](#fonts) - [Fonts](#fonts)
- [Export file types](#export-file-types) - [Export file types](#export-file-types)
@ -40,7 +41,7 @@
<!-- tocstop --> <!-- tocstop -->
## Quickstart (CLI) ## Quickstart
The most convenient way to use D2 is to just run it as a CLI executable to The most convenient way to use D2 is to just run it as a CLI executable to
produce SVGs from `.d2` files. produce SVGs from `.d2` files.
@ -55,13 +56,9 @@ d2 --watch in.d2 out.svg
A browser window will open with `out.svg` and live-reload on changes to `in.d2`. A browser window will open with `out.svg` and live-reload on changes to `in.d2`.
### Install from source ## Install
```sh ### Install script
go install oss.terrastruct.com/d2
```
### Install
The recommended way to install is to run our install script, which will figure out the The recommended way to install is to run our install script, which will figure out the
best way to install based on your machine. E.g. if D2 is available through a package best way to install based on your machine. E.g. if D2 is available through a package
@ -91,7 +88,13 @@ curl -fsSL https://d2lang.com/install.sh | sh -s -- --uninstall
> warn: Our binary releases aren't fully portable like normal Go binaries due to the C > warn: Our binary releases aren't fully portable like normal Go binaries due to the C
> dependency on v8go for executing dagre. > dependency on v8go for executing dagre.
## Quickstart (library) ### Install from source
```sh
go install oss.terrastruct.com/d2
```
## D2 as a library
In addition to being a runnable CLI tool, D2 can also be used to produce diagrams from In addition to being a runnable CLI tool, D2 can also be used to produce diagrams from
Go programs. Go programs.