Mentions ELK layout engine (#19)

This commit is contained in:
Simon Støvring 2022-12-18 13:56:55 +01:00 committed by GitHub
parent f47f6b4bd4
commit 09a28bd5cc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 1 deletions

View File

@ -149,7 +149,7 @@ dependency-graph --syntax mermaid --node-spacing 50 --rank-spacing 150 ~/Develop
#### D2 #### D2
<img width="400" src="./example-d2.png" alt="Example graph rendered with d2." /> <img width="400" src="./example-d2.png" alt="Example graph rendered with D2." />
Specify the `--syntax d2` option to have dependency-graph output a graph using [the d2 scripting language](https://d2lang.com/tour/intro). Specify the `--syntax d2` option to have dependency-graph output a graph using [the d2 scripting language](https://d2lang.com/tour/intro).
@ -160,6 +160,10 @@ curl -fsSL https://d2lang.com/install.sh | sh -s --
dependency-graph --syntax d2 ~/Developer/Example | d2 - graph.png dependency-graph --syntax d2 ~/Developer/Example | d2 - graph.png
``` ```
The ELK layout engine renders some quite tidy graphs, as shown in the example below.
<img width="400" src="./example-d2-elk.png" alt="Example graph rendered with D2 and the ELK layout engine." />
## Graphing Packages Only ## Graphing Packages Only
Pass the `--packages-only` flag to include only the Xcode project and Swift packages in the graph. This omits the libraries and targets within the Xcode project and Swift packages. Pass the `--packages-only` flag to include only the Xcode project and Swift packages in the graph. This omits the libraries and targets within the Xcode project and Swift packages.

BIN
example-d2-elk.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 727 KiB