Skip to content

Commit a49f03c

Browse files
committed
docs(readme): expand the descriptions of each dev tool
1 parent ca84d11 commit a49f03c

File tree

1 file changed

+28
-26
lines changed

1 file changed

+28
-26
lines changed

README.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -38,32 +38,34 @@ Please follow [Angular Commit Message Conventions](https://github.com/angular/an
3838

3939
## Development Environment
4040

41-
To develop Docker Official Images, please install the following:
42-
- [Docker Engine](https://docs.docker.com/engine/install/)
43-
- the Go language runtime (e.g., [ppa:longsleep/golang-backports](https://launchpad.net/~longsleep/+archive/ubuntu/golang-backports))
44-
- [bashbrew](https://github.com/docker-library/bashbrew), the Docker Official Images build tool:
45-
```
46-
git clone --depth=1 https://github.com/docker-library/bashbrew; \
47-
( \
48-
umask 0022; \
49-
cd bashbrew; \
50-
go mod download; \
51-
./bashbrew.sh --version; \
52-
sudo cp bin/bashbrew /usr/local/bin/ \
53-
); \
54-
rm -rf bashbrew
55-
```
56-
- [manifest-tool](https://github.com/estesp/manifest-tool), used to generate the shared tag index:
57-
```bash
58-
git clone --depth=1 https://github.com/estesp/manifest-tool; \
59-
( \
60-
umask 0022; \
61-
cd manifest-tool; \
62-
make binary; \
63-
sudo cp manifest-tool /usr/local/bin/ \
64-
); \
65-
rm -rf manifest-tool
66-
```
41+
To develop Docker Official Images, please install [bashbrew](https://github.com/docker-library/bashbrew), the Docker Official Images build tool:
42+
```bash
43+
git clone --depth=1 https://github.com/docker-library/bashbrew; \
44+
( \
45+
umask 0022; \
46+
cd bashbrew; \
47+
go mod download; \
48+
./bashbrew.sh --version; \
49+
sudo cp bin/bashbrew /usr/local/bin/ \
50+
); \
51+
rm -rf bashbrew
52+
```
53+
Bashbrew uses [manifest-tool](https://github.com/estesp/manifest-tool) to generate the shared tag index:
54+
```bash
55+
git clone --depth=1 https://github.com/estesp/manifest-tool; \
56+
( \
57+
umask 0022; \
58+
cd manifest-tool; \
59+
make binary; \
60+
sudo cp manifest-tool /usr/local/bin/ \
61+
); \
62+
rm -rf manifest-tool
63+
```
64+
Please make note of these tools' dependencies, in particular [GNU Make](https://www.gnu.org/software/make/) and [Go](https://go.dev/).
65+
66+
The templating engine and version tracker require [jq](https://stedolan.github.io/jq/) and [GNU awk](https://www.gnu.org/software/gawk/).
67+
68+
Use [qemu-user-static](https://github.com/multiarch/qemu-user-static) to work with multi-architecture containers.
6769

6870
## Update Process
6971

0 commit comments

Comments
 (0)