Merge pull request #130 from terrastruct/alixander/banner
readme: update
This commit is contained in:
commit
79ec9a5439
6 changed files with 19 additions and 16 deletions
11
README.md
11
README.md
|
|
@ -1,8 +1,8 @@
|
|||
<div align="center">
|
||||
<h1>
|
||||
<img src="./docs/assets/logo.svg" alt="D2" />
|
||||
</h1>
|
||||
<p>A modern DSL that turns text into diagrams.</p>
|
||||
<img src="./docs/assets/banner.png" alt="D2" />
|
||||
<h2>
|
||||
A modern diagram scripting language that turns text to diagrams.
|
||||
</h2>
|
||||
|
||||
[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
|
||||
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
|
|
@ -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-<versio
|
|||
and we recommend doing the same with manually installed releases so that you
|
||||
know where the release directory is for easy uninstall.
|
||||
|
||||
> 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
|
||||
|
|
|
|||
BIN
docs/assets/banner.png
Normal file
BIN
docs/assets/banner.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 363 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.6 MiB After Width: | Height: | Size: 4.2 MiB |
Loading…
Reference in a new issue