diff --git a/README.md b/README.md index 14fa751fa..eb8c0f009 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@
-

- D2 -

-

A modern DSL that turns text into diagrams.

+ D2 +

+ A modern diagram scripting language that turns text to diagrams. +

[Language docs](https://d2lang.com) | [Cheat sheet](./docs/assets/cheat_sheet.pdf) @@ -175,8 +175,7 @@ Contributions are welcome! See [./docs/CONTRIBUTING.md](./docs/CONTRIBUTING.md). ## License -Copyright © 2022 Terrastruct, Inc. Open-source licensed under the Mozilla Public License -2.0. +Open sourced under the Mozilla Public License 2.0. See [./LICENSE.txt](./LICENSE.txt). ## Related diff --git a/d2renderers/d2fonts/NOTICE.txt b/d2renderers/d2fonts/NOTICE.txt index 03854fa54..20201706f 100644 --- a/d2renderers/d2fonts/NOTICE.txt +++ b/d2renderers/d2fonts/NOTICE.txt @@ -1,4 +1,4 @@ -The fonts bundled with D2 are open-source fonts licensed under SIL OPEN FONT +The fonts bundled with D2 are open source fonts licensed under SIL OPEN FONT LICENSE. Attribution: diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index bd8851e7b..b2d42f4e3 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -17,7 +17,7 @@ ## CI -Most of D2's CI is open-sourced in its own +Most of D2's CI is open sourced in its own [repository](https://github.com/terrastruct/ci). You can find commands in the Github workflows. E.g. run `./make.sh fmt` to run the formatter. Please make sure all CI is passing for any PRs. diff --git a/docs/INSTALL.md b/docs/INSTALL.md index cf6599adb..71d3fcd0a 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -1,6 +1,6 @@ # install -This file documents all the ways by which you can install D2. +You may install D2 through any of the following methods. @@ -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 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 diff --git a/docs/assets/banner.png b/docs/assets/banner.png new file mode 100644 index 000000000..3472f6cd0 Binary files /dev/null and b/docs/assets/banner.png differ diff --git a/docs/assets/cli.gif b/docs/assets/cli.gif index 20e0e2f21..82693c8a6 100644 Binary files a/docs/assets/cli.gif and b/docs/assets/cli.gif differ