From 6bb0b69467e600dacd6977a67144b5fb6db5f842 Mon Sep 17 00:00:00 2001 From: Amolith Date: Sat, 26 Apr 2025 18:47:10 -0600 Subject: [PATCH] docs: mention just and upx in readme --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7a44f28f2130177737e3e6d65ab093f0d873937e..7b63bbc6f7492e52f751ac5fa990318a190110f5 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,9 @@ SPDX-FileCopyrightText: Amolith SPDX-License-Identifier: CC0-1.0 --> -Note: this was all written in just a few hours with lots of help from LLMs. I've -reviewed every line, but not thoroughly enough to be confident making this more -public than unlisted. It Works For Me™. - -Avoid sharing and use at your own risk. +**Note:** this was all written in just a few hours with lots of help from LLMs. +I've reviewed every line, but not thoroughly enough yet to be confident making +this more public than unlisted. --- @@ -21,13 +19,20 @@ Ensure you have [the Go toolchain] installed. ```sh git clone https://git.sr.ht/~amolith/lunatask-mcp-server cd lunatask-mcp-server +# specify GOOS and GOARCH if cross-compiling CGO_ENABLED=0 go build -o lunatask-mcp-server . ./lunatask-mcp-server -# it'll generate config.toml with default values. +# it'll generate config.toml with default values # fill them out with your preferred editor ./lunatask-mcp-server ``` +If you have [just], build with `just build` (supports `GOOS` and `GOARCH`). If +you also have [upx], compress the resulting binary with `just upx`. + +[just]: https://github.com/casey/just +[upx]: https://github.com/upx/upx + Point [Home Assistant's MCP integration] at the `/sse` endpoint. [Home Assistant's MCP integration]: https://www.home-assistant.io/integrations/mcp/