Skip to content

Commit ca84d11

Browse files
committed
docs(readme): add development environment setup instructions
1 parent b31978f commit ca84d11

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,35 @@ Please follow [Angular Commit Message Conventions](https://github.com/angular/an
3636
- **update**: a helper script that executes both the version tracker and templating engine; currently only [update.sh](update.sh)
3737
- **versions**: the SATOSA version tracker; includes [versions.sh](versions.sh) and [versions.json](versions.json)
3838

39+
## Development Environment
40+
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+
```
67+
3968
## Update Process
4069

4170
1. If necessary, update the list of version aliases at the beginning of `generate-stackbrew-library.sh`.

0 commit comments

Comments
 (0)