Skip to content

Commit 085302d

Browse files
committed
update readme
1 parent 3977f6f commit 085302d

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,35 @@
11
# Cross-compiling [`zk`](https://github.com/zk-org/zk) with Docker
22

3-
Largely inspired by [dh1tw](https://dh1tw.de/2019/12/cross-compiling-golang-cgo-projects/) and [remoteAudio-xcompile](https://github.com/dh1tw/remoteAudio-xcompile).
4-
Images are when changes are pushed to the main branch using Actions.
3+
Largely inspired by
4+
[dh1tw](https://dh1tw.de/2019/12/cross-compiling-golang-cgo-projects/) and
5+
[remoteAudio-xcompile](https://github.com/dh1tw/remoteAudio-xcompile).
6+
7+
Images are published to ghcr.io when changes are pushed or merged to main.
58

69
## How to invoke?
710

8-
You can compile the `zk` source code directly from the source code directory. As example, for compiling the binary for linux/arm64 you have to execute the following command:
11+
You can compile the `zk` source code directly from the source code directory. As
12+
example, for compiling the binary for linux/arm64 you have to execute the
13+
following command:
914

1015
```sh
1116
docker run --rm -v "$PWD":/usr/src/zk -w /usr/src/zk ghcr.io/zk-org/zk-xcompile:linux-arm64 /bin/bash -c 'make'
1217
```
1318

1419
This call is already set in `zk` `Makefile`, e.g. `make dist-linux-amd64`.
1520

16-
More detail is documented here on [Golang's docker hub](https://hub.docker.com/_/golang).
21+
More detail is documented here on
22+
[Golang's docker hub](https://hub.docker.com/_/golang).
1723

18-
The images are hosted with [ghcr within zk-org](https://github.com/orgs/zk-org/packages/container/zk-xcompile/versions).
24+
The images are hosted with
25+
[ghcr within zk-org](https://github.com/orgs/zk-org/packages/container/zk-xcompile/versions).
1926

2027
## Releasing changes
2128

22-
Clone this repo, make necessary changes, submit a PR.
29+
Clone this repo, make necessary changes, submit a PR.
2330

2431
### Manual building
2532

2633
```sh
2734
docker buildx build -t ghcr.io/zk-org/zk-xcompile:linux-amd64 ./linux-amd64
2835
```
29-

0 commit comments

Comments
 (0)