Skip to content

Commit

Permalink
Update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
patrickhoefler committed Jun 20, 2023
1 parent aa419ec commit 76eb18c
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@

`dockerfilegraph` visualizes your multi-stage Dockerfiles.

It creates a visual graph representation of the build process.
The graph contains the following nodes:
It uses [Graphviz](https://graphviz.org/) to create a visual representation of the build process.
The build graph contains the following nodes:

- All build stages
- The default build target (highlighted in grey)
- External images (with dashed borders)

The edges of the graph represent:
The edges of the build graph represent:

- `FROM ...` dependencies
(with a solid line and a full arrow head)
Expand Down Expand Up @@ -51,7 +51,7 @@ For all the details, see the [options](#more-options) below.
Running `dockerfilegraph` without any arguments will create a `Dockerfile.pdf` in your current working directory.
This PDF contains a visual graph representation of your multi-stage Dockerfile.

#### docker / [nerdctl](https://github.com/containerd/nerdctl)
#### [docker](https://docker.com/) / [nerdctl](https://github.com/containerd/nerdctl)

##### Image based on Ubuntu 22.10

Expand Down Expand Up @@ -82,7 +82,11 @@ brew install patrickhoefler/tap/dockerfilegraph
dockerfilegraph
```

#### [toolctl](https://toolctl.io/)
#### [toolctl](https://github.com/toolctl/toolctl)

Make sure that [Graphviz](https://graphviz.org/) is installed locally.

Then:

```text
toolctl install dockerfilegraph
Expand Down

0 comments on commit 76eb18c

Please sign in to comment.