diff options
| author | HimbeerserverDE <himbeerserverde@gmail.com> | 2023-12-02 19:58:13 +0100 |
|---|---|---|
| committer | HimbeerserverDE <himbeerserverde@gmail.com> | 2023-12-02 19:58:13 +0100 |
| commit | 2a1c8db508b0037774454fbaac0723d87f7cbdff (patch) | |
| tree | 5e03d6e5702bed46096426d3829ac32c10c8da5f | |
| parent | 51be5ee4fea1d701f0d4a7ec162987335ef26f0e (diff) | |
fully document dev builds
| -rw-r--r-- | README.md | 11 | ||||
| -rw-r--r-- | doc/build_env.md | 4 | ||||
| -rw-r--r-- | doc/plugins.md | 3 |
3 files changed, 17 insertions, 1 deletions
@@ -29,6 +29,17 @@ with any of the binary names to limit installation and updating to a single executable. **This is not recommended, however, as it can cause version mismatches between them.** +### Development builds +Build the following binaries from the proxy repository directory: + +``` +go build -race ./cmd/mt-auth-convert +go build -race ./cmd/mt-build-plugin +go build -race ./cmd/mt-multiserver-proxy +``` + +*Do not move the binaries! Doing so breaks automatic plugin builds.* + ## Usage ### Starting diff --git a/doc/build_env.md b/doc/build_env.md index 2b8b00a..4533374 100644 --- a/doc/build_env.md +++ b/doc/build_env.md @@ -10,7 +10,9 @@ All commands are run in the project root directory. ### Compile development version to check for errors ``` -go install -race github.com/HimbeerserverDE/mt-multiserver-proxy/cmd/... +go build -race ./cmd/mt-auth-convert +go build -race ./cmd/mt-build-plugin +go build -race ./cmd/mt-multiserver-proxy ``` ### Install and run latest version diff --git a/doc/plugins.md b/doc/plugins.md index 2e9b2d2..5417446 100644 --- a/doc/plugins.md +++ b/doc/plugins.md @@ -74,6 +74,9 @@ My build environment can be found in [build_env.md](https://github.com/HimbeerserverDE/mt-multiserver-proxy/blob/main/doc/build_env.md). ## Using plugins with development builds +You can build a development version by following the instructions in +[README.md](https://github.com/HimbeerserverDE/mt-multiserver-proxy/blob/main/README.md#development-builds). + If you want to use plugins with a proxy binary produced by `go build` or `go run` (usually for contributing to the proxy), you have to temporarily edit the go.mod file of your plugin. Find the line that says |