Skip to content

Commit 84f188a

Browse files
authored
Merge pull request #3304 from crazy-max/update-readme
chore: readme cleanup
2 parents 3b45220 + 20e99f6 commit 84f188a

File tree

1 file changed

+22
-40
lines changed

1 file changed

+22
-40
lines changed

README.md

Lines changed: 22 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# buildx
1+
# Buildx
22

33
[![GitHub release](https://img.shields.io/github/release/docker/buildx.svg?style=flat-square)](https://github.com/docker/buildx/releases/latest)
44
[![PkgGoDev](https://img.shields.io/badge/go.dev-docs-007d9c?style=flat-square&logo=go&logoColor=white)](https://pkg.go.dev/github.com/docker/buildx)
@@ -9,17 +9,17 @@
99
Buildx is a Docker CLI plugin for extended build capabilities with
1010
[BuildKit](https://github.com/moby/buildkit).
1111

12-
Key features:
12+
> [!TIP]
13+
> **Key features**
14+
> - Familiar UI from `docker build`
15+
> - Full BuildKit capabilities with container driver
16+
> - Multiple builder instance support
17+
> - Multi-node builds for cross-platform images
18+
> - Compose build support
19+
> - High-level builds with [Bake](https://docs.docker.com/build/bake/)
20+
> - In-container driver support (both Docker and Kubernetes)
1321
14-
- Familiar UI from `docker build`
15-
- Full BuildKit capabilities with container driver
16-
- Multiple builder instance support
17-
- Multi-node builds for cross-platform images
18-
- Compose build support
19-
- High-level build options (`bake`)
20-
- In-container driver support (both Docker and Kubernetes)
21-
22-
# Table of Contents
22+
___
2323

2424
- [Installing](#installing)
2525
- [Windows and macOS](#windows-and-macos)
@@ -32,23 +32,9 @@ Key features:
3232
- [Working with builder instances](#working-with-builder-instances)
3333
- [Building multi-platform images](#building-multi-platform-images)
3434
- [Reference](docs/reference/buildx.md)
35-
- [`buildx bake`](docs/reference/buildx_bake.md)
36-
- [`buildx build`](docs/reference/buildx_build.md)
37-
- [`buildx create`](docs/reference/buildx_create.md)
38-
- [`buildx du`](docs/reference/buildx_du.md)
39-
- [`buildx imagetools`](docs/reference/buildx_imagetools.md)
40-
- [`buildx imagetools create`](docs/reference/buildx_imagetools_create.md)
41-
- [`buildx imagetools inspect`](docs/reference/buildx_imagetools_inspect.md)
42-
- [`buildx inspect`](docs/reference/buildx_inspect.md)
43-
- [`buildx ls`](docs/reference/buildx_ls.md)
44-
- [`buildx prune`](docs/reference/buildx_prune.md)
45-
- [`buildx rm`](docs/reference/buildx_rm.md)
46-
- [`buildx stop`](docs/reference/buildx_stop.md)
47-
- [`buildx use`](docs/reference/buildx_use.md)
48-
- [`buildx version`](docs/reference/buildx_version.md)
4935
- [Contributing](#contributing)
5036

51-
# Installing
37+
## Installing
5238

5339
Using Buildx with Docker requires Docker engine 19.03 or newer.
5440

@@ -57,18 +43,18 @@ Using Buildx with Docker requires Docker engine 19.03 or newer.
5743
> and will likely cause issues, especially when using Buildx builders with more
5844
> recent versions of BuildKit.
5945
60-
## Windows and macOS
46+
### Windows and macOS
6147

6248
Docker Buildx is included in [Docker Desktop](https://docs.docker.com/desktop/)
6349
for Windows and macOS.
6450

65-
## Linux packages
51+
### Linux packages
6652

6753
Docker Engine package repositories contain Docker Buildx packages when installed according to the
6854
[Docker Engine install documentation](https://docs.docker.com/engine/install/). Install the
6955
`docker-buildx-plugin` package to install the Buildx plugin.
7056

71-
## Manual download
57+
### Manual download
7258

7359
> [!IMPORTANT]
7460
> This section is for unattended installation of the Buildx component. These
@@ -107,7 +93,7 @@ On Windows:
10793
> $ chmod +x ~/.docker/cli-plugins/docker-buildx
10894
> ```
10995
110-
## Dockerfile
96+
### Dockerfile
11197
11298
Here is how to install and use Buildx inside a Dockerfile through the
11399
[`docker/buildx-bin`](https://hub.docker.com/r/docker/buildx-bin) image:
@@ -119,7 +105,7 @@ COPY --from=docker/buildx-bin /buildx /usr/libexec/docker/cli-plugins/docker-bui
119105
RUN docker buildx version
120106
```
121107
122-
# Building
108+
## Building
123109

124110
```console
125111
# Buildx 0.6+
@@ -137,9 +123,9 @@ $ git clone https://github.com/docker/buildx.git && cd buildx
137123
$ make install
138124
```
139125

140-
# Getting started
126+
## Getting started
141127

142-
## Building with Buildx
128+
### Building with Buildx
143129

144130
Buildx is a Docker CLI plugin that extends the `docker build` command with the
145131
full support of the features provided by [Moby BuildKit](https://docs.docker.com/build/buildkit/)
@@ -184,7 +170,7 @@ and [drivers](https://docs.docker.com/build/builders/drivers/) guide.
184170
> [!NOTE]
185171
> For more information, see [Docker Build docs](https://docs.docker.com/build/concepts/overview/).
186172
187-
## Working with builder instances
173+
### Working with builder instances
188174

189175
By default, Buildx will initially use the `docker` driver if it is supported,
190176
providing a very similar user experience to the native `docker build`. Note that
@@ -222,7 +208,7 @@ target.
222208
> [!NOTE]
223209
> For more information, see [Builders docs](https://docs.docker.com/build/builders/).
224210
225-
## Building multi-platform images
211+
### Building multi-platform images
226212

227213
BuildKit is designed to work well for building for multiple platforms and not
228214
only for the architecture and operating system that the user invoking the build
@@ -303,11 +289,7 @@ cross-compilation helpers for more advanced use-cases.
303289
> [!NOTE]
304290
> For more information, see [Multi-platform builds docs](https://docs.docker.com/build/building/multi-platform/).
305291
306-
## High-level build options
307-
308-
See [High-level builds with Bake](https://docs.docker.com/build/bake/) for more details.
309-
310-
# Contributing
292+
## Contributing
311293

312294
Want to contribute to Buildx? Awesome! You can find information about
313295
contributing to this project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md)

0 commit comments

Comments
 (0)