From a18f86a23e7a18882153971aaeb212ec8070efe5 Mon Sep 17 00:00:00 2001 From: Luxferre Date: Sat, 21 Mar 2026 17:16:48 +0200 Subject: [PATCH] added a Makefile and updated the readme --- Makefile | 36 ++++++++++++++++++++++++++++++++++++ README.md | 16 +++++++++++----- 2 files changed, 47 insertions(+), 5 deletions(-) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..a29f1b0 --- /dev/null +++ b/Makefile @@ -0,0 +1,36 @@ +# Sidekick Makefile (POSIX sh compatible) +.POSIX: + +# Configuration +PREFIX = /usr/local +BIN_DIR = bin +TUI_SRC = ./cmd/sidekick-tui +MCP_SRC = ./cmd/sidekick-mcp +TUI_BIN = $(BIN_DIR)/sidekick-tui +MCP_BIN = $(BIN_DIR)/sidekick-mcp + +.PHONY: all build test clean install uninstall + +all: build + +build: + @mkdir -p $(BIN_DIR) + go build -o $(TUI_BIN) $(TUI_SRC) + go build -o $(MCP_BIN) $(MCP_SRC) + +test: + go test -v ./... + +clean: + rm -rf $(BIN_DIR) + +install: build + mkdir -p $(PREFIX)/bin + cp -f $(TUI_BIN) $(PREFIX)/bin/sidekick-tui + cp -f $(MCP_BIN) $(PREFIX)/bin/sidekick-mcp + chmod 755 $(PREFIX)/bin/sidekick-tui + chmod 755 $(PREFIX)/bin/sidekick-mcp + +uninstall: + rm -f $(PREFIX)/bin/sidekick-tui + rm -f $(PREFIX)/bin/sidekick-mcp diff --git a/README.md b/README.md index 7331dca..81d953a 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ toolsets = ["filesystem"] To use Sidekick as a framework in your own Go projects: ```bash -go get github.com/yourusername/sidekick-ng +go get codeberg.org/luxferre/sidekick-ng ``` ### Installing the TUI @@ -57,13 +57,19 @@ go get github.com/yourusername/sidekick-ng To install the Sidekick TUI binary globally: ```bash -go install github.com/yourusername/sidekick-ng/cmd/sidekick-tui@latest +go install codeberg.org/luxferre/sidekick-ng/cmd/sidekick-tui@latest ``` -Alternatively, you can build it locally from the source: +Alternatively, you can build it locally from the source using the provided `Makefile`: ```bash -git clone https://github.com/yourusername/sidekick-ng.git +make +``` + +Or manually: + +```bash +git clone https://codeberg.org/luxferre/sidekick-ng.git cd sidekick-ng go build -o bin/sidekick-tui ./cmd/sidekick-tui ``` @@ -170,7 +176,7 @@ import ( "fmt" "log" - "github.com/yourusername/sidekick-ng" + "codeberg.org/luxferre/sidekick-ng" ) func main() {