Skip to content

Document release binary usage in README #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
linletian merged 1 commit into from
Mar 11, 2026
Merged

Document release binary usage in README #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,34 @@ myworktree is a thin management layer that:

## Quick start

### Release binaries

If you just want to use `myworktree`, download the latest release assets from GitHub Releases:

- Apple Silicon Macs: `myworktree_vX.Y.Z_darwin_arm64.tar.gz`
- Intel Macs: `myworktree_vX.Y.Z_darwin_amd64.tar.gz`
- Integrity file: `checksums.txt`

Example:

```bash
# Pick the archive that matches your Mac, then verify and unpack it.
curl -LO https://github.com/linletian/myworktree/releases/download/v0.1.0/myworktree_v0.1.0_darwin_arm64.tar.gz
curl -LO https://github.com/linletian/myworktree/releases/download/v0.1.0/checksums.txt
shasum -a 256 -c checksums.txt --ignore-missing
tar -xzf myworktree_v0.1.0_darwin_arm64.tar.gz

# Optional: install into PATH
sudo install -m 755 ./mw /usr/local/bin/mw
sudo install -m 755 ./myworktree /usr/local/bin/myworktree

# Verify the downloaded binary
mw --version
```

Each release archive contains `mw`, `myworktree`, `README.md`, `LICENSE`, and `CHANGELOG.md`.
If there is no prerelease/release asset yet, or you need a platform we do not publish, follow the source build steps below.

### Build & install

```bash
Expand Down
28 changes: 28 additions & 0 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,34 @@ myworktree 只做管理，不碰项目具体内容：

## 快速开始

### 发布版使用

如果你只是想直接使用 `myworktree`，推荐从 GitHub Releases 下载已打包的发布版：

- Apple Silicon Mac：`myworktree_vX.Y.Z_darwin_arm64.tar.gz`
- Intel Mac：`myworktree_vX.Y.Z_darwin_amd64.tar.gz`
- 校验文件：`checksums.txt`

示例：

```bash
# 根据你的 Mac 机型选择对应压缩包，然后校验并解压
curl -LO https://github.com/linletian/myworktree/releases/download/v0.1.0/myworktree_v0.1.0_darwin_arm64.tar.gz
curl -LO https://github.com/linletian/myworktree/releases/download/v0.1.0/checksums.txt
shasum -a 256 -c checksums.txt --ignore-missing
tar -xzf myworktree_v0.1.0_darwin_arm64.tar.gz

# 可选：安装到 PATH
sudo install -m 755 ./mw /usr/local/bin/mw
sudo install -m 755 ./myworktree /usr/local/bin/myworktree

# 验证下载下来的二进制
mw --version
```

每个发布压缩包内都包含 `mw`、`myworktree`、`README.md`、`LICENSE` 和 `CHANGELOG.md`。
如果当前还没有预发布/正式发布压缩包，或者你的平台暂无对应产物，就直接使用下面的源码编译步骤。

### Build & install

```bash
Expand Down