aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordavid_eldios_ <[email protected]>2026-10-06 01:20:16 -0300
committerGitHub <[email protected]>2026-10-06 01:20:16 -0300
commit77966bb6356409df6cec32e7b87f2bb05690a74c (patch)
treeee1fddf4e2d00440b2e2035384ff77f36d50f913
parent381581cc7b64ee7803f8016784bbe0cde448e64c (diff)
downloadmikusays-c-77966bb6356409df6cec32e7b87f2bb05690a74c.tar.gz
mikusays-c-77966bb6356409df6cec32e7b87f2bb05690a74c.zip
update installation section in README
Added installation instructions for downloading binaries and building from source.
-rw-r--r--README.md23
1 files changed, 22 insertions, 1 deletions
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
```