Skip to content

docs: fix README build requirements and add installation links #830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
patrickhoefler merged 2 commits into from
Mar 28, 2026
Merged

docs: fix README build requirements and add installation links #830

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1cceda
docs: fix README build requirements and add installation links
patrickhoefler Mar 28, 2026
cf9e296
docs: add missing mise install to container build instructions
patrickhoefler Mar 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ Supports multiple output formats (PDF, SVG, PNG), a legend, and layout customiza

Run `dockerfilegraph` in your project directory to generate a `Dockerfile.pdf` with your build graph.

#### Docker
#### [Docker](https://www.docker.com/)

```shell
docker run --rm --user "$(id -u):$(id -g)" \
-v "$(pwd)":/workspace -w /workspace \
ghcr.io/patrickhoefler/dockerfilegraph
```

#### Homebrew
#### [Homebrew](https://brew.sh/)

```shell
brew install patrickhoefler/tap/dockerfilegraph
Expand All @@ -79,18 +79,20 @@ dockerfilegraph

- **Native Build**

*Requirements: [Go](https://go.dev/), [mise](https://mise.jdx.dev/) and [Graphviz](https://graphviz.org/)*
*Requirements: [mise](https://mise.jdx.dev/) and [Graphviz](https://graphviz.org/)*

```shell
mise install
mise run build
./dockerfilegraph
```

- **Container Build**

*Requirements: [Go](https://go.dev/), [mise](https://mise.jdx.dev/) and Docker*
*Requirements: [mise](https://mise.jdx.dev/) and [Docker](https://www.docker.com/)*

```shell
mise install
mise run build-docker-image
docker run \
--rm \
Expand Down
Loading