summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIvan Potiienko <[email protected]>2026-08-31 22:07:34 +0200
committerIvan Potiienko <[email protected]>2026-08-31 22:07:34 +0200
commit531480d8983d063b982968ad199ae0b959d903df (patch)
tree3c9ebed481e6854d5065d7e3de07dc521b003916 /README.md
parent3e964f98da759c438e6d3a0467df346de7a3d236 (diff)
downloadmikusays-c-531480d8983d063b982968ad199ae0b959d903df.tar.gz
mikusays-c-531480d8983d063b982968ad199ae0b959d903df.zip
Prepare v0.1.5 release
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 28 insertions, 2 deletions
diff --git a/README.md b/README.md
index dd83524..81f3e15 100644
--- a/README.md
+++ b/README.md
@@ -74,8 +74,23 @@ brew install mikusays
- **Windows**: `mikusays-windows-*.exe`
- Small note for Windows that application depends on `vcredist2022`
(installing with scoop and installer resolve this dependency automatically)
-- **Linux**: `mikusays-linux-*`
-- **macOS**: `mikusays-macos-*`
+- **Linux**: `mikusays-linux-*.tar.gz`
+- **macOS**: `mikusays-macos-*.tar.gz`
+
+Linux and macOS archives preserve the executable permission. Extract and run one with:
+
+```bash
+archive="mikusays-linux-x64-VERSION.tar.gz"
+tar -xzf "$archive"
+"./${archive%.tar.gz}" "Hello, World!"
+```
+
+The macOS binaries are currently unsigned. If Gatekeeper quarantines an extracted binary,
+remove the quarantine attribute before running it:
+
+```bash
+xattr -d com.apple.quarantine ./mikusays-macos-arm64-VERSION
+```
Or build from source:
```bash
@@ -84,6 +99,17 @@ cargo build --release
## Development
+### Release automation
+
+Tagged releases build the platform binaries first, then trigger the Scoop bucket.
+After all DEB and RPM assets have uploaded, the package workflow triggers the APT/RPM
+repository with the exact tag. The `RELEASE_TOKEN` Actions secret must be able to create
+repository dispatch events in `xxanqw/scoop-bucket`, `xxanqw/homebrew-mikusays`, and
+`xxanqw/apt-repository`.
+
+The distribution repositories keep scheduled and manual workflows as recovery paths if
+an event dispatch fails.
+
1. Fork repository
2. Clone your fork
3. Implement your changes