Skip to content

Commit db5fac8

Browse files
committed
update README.md
1 parent 75eb96d commit db5fac8

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,3 +224,23 @@ docker run -it --rm \
224224
- [`SSL_CERT_FILE`](https://go.dev/src/crypto/x509/root_unix.go#L19): Specifies the path to an SSL certificate.
225225
- [`SSL_CERT_DIR`](https://go.dev/src/crypto/x509/root_unix.go#L25): Identifies which directory to check for SSL certificate files.
226226
- `SSL_CERT_BASE64`: Specifies a base64-encoded SSL certificate that will be added to the global certificate pool on start.
227+
228+
229+
# Local Development
230+
231+
Building `envbuilder` currently **requires** a Linux system.
232+
233+
On MacOS or Windows systems, we recommend either using a VM or the provided `.devcontainer` for development.
234+
235+
**Additional Requirements:**
236+
237+
- `go 1.21`
238+
- `make`
239+
- Docker daemon (for running tests)
240+
241+
**Makefile targets:**
242+
243+
- `build`: builds and tags `envbuilder:latest` for your current architecture.
244+
- `develop`: runs `envbuilder:latest` against a sample Git repository.
245+
- `test`: run tests.
246+
- `test-registry`: stands up a local registry for caching images used in tests.

0 commit comments

Comments
 (0)