diff options
| author | HimbeerserverDE <himbeerserverde@gmail.com> | 2023-07-16 18:04:07 +0200 |
|---|---|---|
| committer | HimbeerserverDE <himbeerserverde@gmail.com> | 2023-07-16 18:04:07 +0200 |
| commit | 43b3d28f4ecb016023b994dd28f796cb7921551b (patch) | |
| tree | d47c24cfc8a9c610e4a6c0184ed7f8b3a13114a8 | |
| parent | 52c56ace19708cfcf5d8c91c4f602d563b82dd39 (diff) | |
additional documentation md cleanups
| -rw-r--r-- | README.md | 6 | ||||
| -rw-r--r-- | doc/build_env.md | 5 | ||||
| -rw-r--r-- | doc/plugins.md | 2 |
3 files changed, 11 insertions, 2 deletions
@@ -9,7 +9,9 @@ This project was made possible by [anon55555's mt module](https://github.com/ano ## Installation Go 1.18 or higher is required. Run -`go install github.com/HimbeerserverDE/mt-multiserver-proxy/cmd/mt-multiserver-proxy@latest` +``` +go install github.com/HimbeerserverDE/mt-multiserver-proxy/cmd/mt-multiserver-proxy@latest +``` to download and compile the project. A mt-multiserver-proxy executable will be created in your $GOBIN directory. The same command is also @@ -19,7 +21,7 @@ all plugins after upgrading. ## Usage ### Starting -Run `$GOBIN/mt-multiserver-proxy`. The configuration file and other required +Run `${GOBIN}/mt-multiserver-proxy`. The configuration file and other required files are created automatically in the directory the executable (or symlink to said executable) is in, so make sure to move the executable to the desired location or use a symlink. diff --git a/doc/build_env.md b/doc/build_env.md index 88c9bda..8a53532 100644 --- a/doc/build_env.md +++ b/doc/build_env.md @@ -1,18 +1,23 @@ # Build environment + ## `go version` ``` go version go1.18.1 linux/amd64 ``` + ## Build commands 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/mt-multiserver-proxy ``` + ### Install and run latest version ``` go install -race github.com/HimbeerserverDE/mt-multiserver-proxy/cmd/mt-multiserver-proxy@latest && ~/go/bin/mt-multiserver-proxy ``` + ## Formatting ``` goimports -l -w . diff --git a/doc/plugins.md b/doc/plugins.md index 9ff5a54..5b50454 100644 --- a/doc/plugins.md +++ b/doc/plugins.md @@ -6,9 +6,11 @@ need to restart the proxy. ## Installing plugins To install a plugin, clone the repository, cd into it and run: + ``` go build -buildmode=plugin ``` + A .so file will be created. Copy or move this file into the `plugins` directory. Restart the proxy to load the plugin. |