diff --git a/README.md b/README.md index 71253b9..31c00a8 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,36 @@ 4. 启动本工具,填写连接码并配置按键事件,开始监听即可 +5. 可使用菜单“文件”中的“保存配置”和“读取配置”保存/读取 `.json` 格式的配置文件([示例配置文件](https://gitea.miri.site/Mr_Fang/cgh_keyboard_fire_tool/src/branch/master/example.json)) + ## 注意事项 -停止监听并不能完全注销热键,需要关闭整个工具,所以若有重新监听需求建议直接重新启动程序 \ No newline at end of file +**停止监听并不能完全注销热键,需要关闭整个工具,所以若有重新监听需求建议直接重新启动程序** + +## 进入开发 + +1. 克隆本仓库到本地 + +```shell +git clone https://gitea.miri.site/Mr_Fang/cgh_keyboard_fire_tool.git +``` + +2. 初始化开发环境 + +```shell +pip install -r requirements.txt +``` + +3. 作出修改 + +4. 使用 PyInstaller 构建可执行文件 + +```shell +pyinstaller --clean --noconfirm main.spec +``` + +5. 在 `./dist/` 下即可找到构建产物 + +## 开源许可 + +本工具使用 [Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/) 开源许可协议 \ No newline at end of file