From 77966bb6356409df6cec32e7b87f2bb05690a74c Mon Sep 17 00:00:00 2001 From: david_eldios_ Date: Tue, 6 Oct 2026 01:20:16 -0300 Subject: update installation section in README Added installation instructions for downloading binaries and building from source. --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5ea9e75..bcf8e54 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,28 @@ mikusays --help ## Installation -build from source: +### Download from [Releases](https://github.com/davideldios7/mikusays/releases): + +- **Windows**: `mikusays-*-windows.zip` +- **Linux**: `mikusays-*-linux.tar.gz` +- **macOS**: `mikusays-*-macos-*.tar.gz` + +Linux and macOS archives should preserve the executable permission. Extract and run one with: + +```bash +tar -xzf "mikusays-VERSION" +cd mikusays-VERSION +./mikusays hi +``` + +The macOS binaries are unsigned. If Gatekeeper quarantines an extracted binary, +remove the quarantine attribute before running it: + +```bash +xattr -d com.apple.quarantine ./mikusays-VERSION-macos-arm64 +``` + +or build from source: ```bash ./configure ``` -- cgit v1.3-2-g0d8e