Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
amorphobia committed Oct 2, 2024
1 parent a75ebca commit 7962b77
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,33 @@

发行版会在 [Release 页面](https://github.com/amorphobia/rabbit/releases) 的 Assets 中,下载最新的 `rabbit-v<版本号>.zip`,解压到一个新建文件夹,运行 `Rabbit.exe` 即可。

## 脚本编译

本仓库提供*源码形式的玉兔毫脚本*以及*仅修改主图标的 AutoHotkey 可执行文件*,用户可根据需要自行编译为可执行文件以及压缩。编译方式可参照 AutoHotkey 的[官方文档](https://www.autohotkey.com/docs/v2/Scripts.htm#ahk2exe)

编译并使用 `upx` 压缩后,64 位的可执行文件大小可减少为 `Rabbit.exe` - 约 570 KB, `RabbitDeployer.exe` - 约 562 KB。

## 目录结构

> [!NOTE]
> 以下描述的*可删除**编译后可删除*指的是删除后不影响使用,若要再次分发脚本或编译后的可执行文件,需遵守 [GPL-3.0 开源许可](LICENSE)
```
rabbit/
├─ Data/ 预设方案以及必要配置,内容删除后可能无法正常使用,若用户目录包含所有必要文件,可删除
├─ Lib/ 玉兔毫运行依赖脚本库,编译后可删除
| ├─ librime-ahk Rime 引擎的 AutoHotkey 绑定,编译后可删除
| | ├─ rime.dll Rime 引擎的动态库,若本机已安装小狼毫,可删除;若没有安装小狼毫,需要 a. 保留在此,或 b. 放到主目录,或 c. 放到环境变量 "LIBRIME_LIB_DIR" 指定的目录
| | ├─ ... librime-ahk 库的其他脚本,编译后可删除
| ├─ ... 其他依赖,编译后可删除
├─ Rime/ Rime 用户文件夹,运行后会自动生成;可修改注册表 "HKEY_CURRENT_USER\Software\Rime\Rabbit" 中的 "RimeUserDir" 来指定不同的用户文件夹
├─ LICENSE 开源许可,可删除
├─ Rabbit.ahk 玉兔毫主程序脚本
├─ Rabbit.exe AutoHotkey 可执行文件,若本机已安装 AutoHotkey 或已编译,可删除
├─ RabbitDeployer.ahk 玉兔毫部署应用脚本
├─ README.md 本文件,可删除
```

## 开源许可

[GPL-3.0](LICENSE)
Expand Down

0 comments on commit 7962b77

Please sign in to comment.