Updated the README.md

This commit is contained in:
moony 2022-01-11 13:32:17 -08:00
parent 92266ae01e
commit 20694ced61

@ -1,22 +1,11 @@
# Go app template build environment
# MullFast - Mullvad VPN Server Latency Tester
This is a skeleton project for a Go application, which captures the best build
techniques I have learned to date. It uses a Makefile to drive the build (the
universal API to software projects) and a Dockerfile to build a docker image.
This project was made mostly to aid users who do not use the Mullvad client.
It pings each online WireGuard or OpenVPN Mullvad server to find the one with the best latency for your location.
This has only been tested on Linux, but should work on Windows as well.
This has only been tested on Linux, and depends on Docker to build.
## Customizing it
To use this, simply copy these files and make the following changes:
Makefile:
- change `BIN` to your binary name
- rename `cmd/myapp` to `cmd/$BIN`
- change `REGISTRY` to the Docker registry you want to use
- maybe change `SRC_DIRS` if you use some other layout
- choose a strategy for `VERSION` values - git tags or manual
## Build Changes
Dockerfile.in:
- maybe change or remove the `USER` if you need
@ -25,12 +14,12 @@ Dockerfile.in:
This assumes the use of go modules (which will be the default for all Go builds
as of Go 1.13) and vendoring (which reasonable minds might disagree about).
You will need to run `go mod vendor` to create a `vendor` directory when you
have dependencies.
have dependencies if you're wanting to modify the code in any way.
## Building
Run `make` or `make build` to compile your app. This will use a Docker image
to build your app, with the current directory volume-mounted into place. This
Run `make` or `make build` to compile the app. This will use a Docker image
to build the app, with the current directory volume-mounted into place. This
will store incremental state for the fastest possible build. Run `make
all-build` to build for all architectures.