Skip to content

Commit 1ad1bdb

Browse files
committed
update readme
1 parent 34726a5 commit 1ad1bdb

2 files changed

Lines changed: 51 additions & 51 deletions

File tree

README-CN.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -45,49 +45,49 @@
4545

4646
## 📦 安装
4747

48-
### 安装方式选择
48+
### macOS
4949

50-
| 使用场景 | 推荐方式 | 说明 |
51-
|---------|----------|------|
52-
| macOS 本地使用 | Homebrew | 默认安装带 OCR 的版本,并自动拉取 `tesseract` |
53-
| Linux / macOS 手动部署 | GitHub Releases | 下载预编译压缩包,并确保系统里有 Tesseract 运行时 |
54-
| Go 项目集成或自定义构建 | 源码编译 | 适合把 `kbr` 集成进自己的工具链或服务中 |
55-
56-
### Homebrew
50+
macOS 下使用 Homebrew 安装:
5751

5852
```bash
5953
brew tap libi/tap
6054
brew install ko-browser
61-
# 或者不先 tap,直接安装:
55+
56+
# 或者不先 tap,直接安装
6257
brew install libi/tap/ko-browser
6358
```
6459

6560
> Homebrew 安装的是带 OCR 的 `kbr`
66-
> 它会自动安装 `tesseract`,并通过源码编译
61+
> 它会自动安装 `tesseract`
6762
> Tap 仓库是 [libi/homebrew-tap](https://github.com/libi/homebrew-tap)
6863
69-
### 预编译二进制
64+
### Windows
7065

71-
[GitHub Releases](https://github.com/libi/ko-browser/releases) 下载
66+
Windows 下从 [GitHub Releases](https://github.com/libi/ko-browser/releases) 下载最新 release,解压后直接运行 `kbr.exe`
7267

73-
> GitHub Release 提供的二进制同样是带 OCR 的版本。
74-
> 使用前请先安装 Tesseract 运行时库:macOS 用 `brew install tesseract`,Linux 用 `apt install libtesseract-dev`
68+
```powershell
69+
Invoke-WebRequest -Uri https://github.com/libi/ko-browser/releases/latest/download/ko-browser-windows-amd64.zip -OutFile ko-browser-windows-amd64.zip
70+
Expand-Archive .\ko-browser-windows-amd64.zip -DestinationPath .\ko-browser
71+
.\ko-browser\kbr.exe --help
72+
```
7573

76-
```bash
77-
# macOS (Apple Silicon)
78-
curl -LO https://github.com/libi/ko-browser/releases/latest/download/ko-browser-darwin-arm64.tar.gz
79-
tar xzf ko-browser-darwin-arm64.tar.gz
80-
mv kbr /usr/local/bin/kbr
74+
如果希望在任意目录直接使用 `kbr`,可以把 `kbr.exe` 移动到已经在 `PATH` 里的目录,或者把解压目录加入 `PATH`
75+
76+
### Linux
8177

82-
# macOS (Intel)
83-
curl -LO https://github.com/libi/ko-browser/releases/latest/download/ko-browser-darwin-amd64.tar.gz
84-
tar xzf ko-browser-darwin-amd64.tar.gz
85-
mv kbr /usr/local/bin/kbr
78+
Linux 下从 [GitHub Releases](https://github.com/libi/ko-browser/releases) 下载最新 release,解压后放到 `PATH` 目录:
8679

87-
# Linux (amd64)
80+
```bash
8881
curl -LO https://github.com/libi/ko-browser/releases/latest/download/ko-browser-linux-amd64.tar.gz
8982
tar xzf ko-browser-linux-amd64.tar.gz
90-
mv kbr /usr/local/bin/kbr
83+
chmod +x kbr
84+
sudo mv kbr /usr/local/bin/kbr
85+
```
86+
87+
Release 二进制默认带 OCR,请确保宿主机安装了 Tesseract 运行时,例如:
88+
89+
```bash
90+
sudo apt install libtesseract-dev
9191
```
9292

9393
### 源码编译

README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -56,49 +56,49 @@ Its custom accessibility-tree snapshot format reduces prompt footprint by **46%+
5656

5757
## 📦 Installation
5858

59-
### Choose an install path
59+
### macOS
6060

61-
| Use case | Recommended path | Notes |
62-
|---------|------------------|-------|
63-
| macOS local usage | Homebrew | Installs an OCR-enabled build and pulls in `tesseract` |
64-
| Linux/macOS manual deployment | GitHub Releases | Download the prebuilt archive and make sure Tesseract runtime libraries are present |
65-
| Go-based integration or custom builds | From source | Best when embedding `kbr` into your own toolchain |
66-
67-
### Homebrew
61+
Use Homebrew:
6862

6963
```bash
7064
brew tap libi/tap
7165
brew install ko-browser
72-
# or without tapping first:
66+
67+
# or install directly without tapping first
7368
brew install libi/tap/ko-browser
7469
```
7570

76-
> Homebrew installs `kbr` with OCR enabled.
77-
> It pulls in `tesseract` automatically and builds from source.
71+
> This installs the OCR-enabled `kbr` build.
72+
> Homebrew also pulls in `tesseract` automatically.
7873
> The tap repository is [libi/homebrew-tap](https://github.com/libi/homebrew-tap).
7974
80-
### Pre-built binaries
75+
### Windows
8176

82-
Download from [GitHub Releases](https://github.com/libi/ko-browser/releases):
77+
Download the latest release package from [GitHub Releases](https://github.com/libi/ko-browser/releases), then unzip and run `kbr.exe`.
8378

84-
> Release binaries are also built with OCR enabled.
85-
> Install Tesseract first so the runtime OCR libraries are available: `brew install tesseract` on macOS, `apt install libtesseract-dev` on Linux.
79+
```powershell
80+
Invoke-WebRequest -Uri https://github.com/libi/ko-browser/releases/latest/download/ko-browser-windows-amd64.zip -OutFile ko-browser-windows-amd64.zip
81+
Expand-Archive .\ko-browser-windows-amd64.zip -DestinationPath .\ko-browser
82+
.\ko-browser\kbr.exe --help
83+
```
8684

87-
```bash
88-
# macOS (Apple Silicon)
89-
curl -LO https://github.com/libi/ko-browser/releases/latest/download/ko-browser-darwin-arm64.tar.gz
90-
tar xzf ko-browser-darwin-arm64.tar.gz
91-
mv kbr /usr/local/bin/kbr
85+
If you want to use `kbr` globally, move `kbr.exe` into a directory that is already in your `PATH`, or add the extracted folder to `PATH`.
86+
87+
### Linux
9288

93-
# macOS (Intel)
94-
curl -LO https://github.com/libi/ko-browser/releases/latest/download/ko-browser-darwin-amd64.tar.gz
95-
tar xzf ko-browser-darwin-amd64.tar.gz
96-
mv kbr /usr/local/bin/kbr
89+
Download the latest release package from [GitHub Releases](https://github.com/libi/ko-browser/releases), extract it, and place `kbr` somewhere in your `PATH`.
9790

98-
# Linux (amd64)
91+
```bash
9992
curl -LO https://github.com/libi/ko-browser/releases/latest/download/ko-browser-linux-amd64.tar.gz
10093
tar xzf ko-browser-linux-amd64.tar.gz
101-
mv kbr /usr/local/bin/kbr
94+
chmod +x kbr
95+
sudo mv kbr /usr/local/bin/kbr
96+
```
97+
98+
Release binaries are built with OCR enabled, so make sure the Tesseract runtime is available on the host:
99+
100+
```bash
101+
sudo apt install libtesseract-dev
102102
```
103103

104104
### From source

0 commit comments

Comments
 (0)