From 0f56916295c349cfefdbcf36f0985798a7156dea Mon Sep 17 00:00:00 2001 From: bdnugget Date: Sun, 19 Jan 2025 01:33:01 +0100 Subject: [PATCH] Add build instructions --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index f191cb4..2b3db5a 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,26 @@ go run main.go -addr somehost:6970 # Uses somehost:6970 Note: The `-local` flag is a shorthand for `-addr localhost:6969` and cannot be used together with `-addr`. +## Building Release Binaries + +The project uses Docker to create consistent builds across platforms. To build release binaries: + +1. Build the Docker image (only needed once): +```bash +sudo docker build -t goonscape-builder -f Dockerfile.build . +``` + +2. Create release builds: +```bash +sudo docker run -v $(pwd):/build goonscape-builder +``` + +This will create zip files in the `build` directory for: +- Windows (64-bit): `goonscape-windows-amd64-v1.0.0.zip` +- Linux (64-bit): `goonscape-linux-amd64-v1.0.0.zip` + +Each zip contains the binary and all required assets. + ## Development The project uses Protocol Buffers for network communication. If you modify the `.proto` files, regenerate the Go code with: