From 02e27a42fafa444bcb4f5faedc23402841c7e089 Mon Sep 17 00:00:00 2001 From: fengfeng-zi Date: Sun, 26 Apr 2026 17:00:51 +0800 Subject: [PATCH 1/2] docs: add Windows install guide --- docs/install-windows.md | 51 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 docs/install-windows.md diff --git a/docs/install-windows.md b/docs/install-windows.md new file mode 100644 index 0000000..2283d43 --- /dev/null +++ b/docs/install-windows.md @@ -0,0 +1,51 @@ +# Install on Windows + +This guide is for newcomers who want to install or run the Windows version of AhaKey. + +## Recommended: install from GitHub Releases + +1. Open the `AhakeyAI/desktop` **Releases** page. +2. Download the latest Windows installer asset (`.exe` or `.msi`). +3. Run the installer and follow the setup wizard. +4. Launch AhaKey from the Start Menu after installation. + +> Note: this repository is source-only. Installer binaries are distributed via GitHub Releases, not committed in the repo. + +## For contributors: run Windows modules from source + +There is currently no single one-click Windows build entry. Build/run by module: + +### 1) desktop-main + +- Path: `platforms/windows/desktop-main/vibe_code_config_tool/` +- Typical dev start: + - `pip install -r requirements.txt` + - `python main.py` + +### 2) ble-bridge + +- Path: `platforms/windows/ble-bridge/BLE_tcp_bridge_for_vibe_code/` +- Typical build: + - Open `BLE_tcp_driver.sln` in Visual Studio and build + - Or build `BLE_tcp_driver.csproj` with .NET Framework 4.7.2 toolchain + +### 3) hook-installer + +- Path: `platforms/windows/hook-installer/vibe_code_hook/` +- Common entry scripts: + - `python hook_install.py` + - `python install_hook.py` + - `python install_cursor_hook.py` + +### 4) speech + +- Path: `platforms/windows/speech/Capswriter/` +- Typical dev start: + - `pip install -r requirements.txt` + - `python start_server.py` + - `python start_client.py` + +## Scope and expectations + +- This repo does **not** include release artifacts like `exe` / `msi`. +- Historical packaging scripts (for example under `platforms/windows/scripts/inno-setup/`) are retained for migration reference and may not be directly reusable as current release pipelines. From 6c6b1ea8581dedf3ffb26111b7dc53a88e1154e6 Mon Sep 17 00:00:00 2001 From: fengfeng-zi Date: Wed, 29 Apr 2026 17:39:06 +0800 Subject: [PATCH 2/2] docs: fold Windows install guide into existing docs --- docs/install-windows.md | 51 ------------------------------------- docs/installation.md | 1 + platforms/windows/README.md | 9 +++++++ 3 files changed, 10 insertions(+), 51 deletions(-) delete mode 100644 docs/install-windows.md diff --git a/docs/install-windows.md b/docs/install-windows.md deleted file mode 100644 index 2283d43..0000000 --- a/docs/install-windows.md +++ /dev/null @@ -1,51 +0,0 @@ -# Install on Windows - -This guide is for newcomers who want to install or run the Windows version of AhaKey. - -## Recommended: install from GitHub Releases - -1. Open the `AhakeyAI/desktop` **Releases** page. -2. Download the latest Windows installer asset (`.exe` or `.msi`). -3. Run the installer and follow the setup wizard. -4. Launch AhaKey from the Start Menu after installation. - -> Note: this repository is source-only. Installer binaries are distributed via GitHub Releases, not committed in the repo. - -## For contributors: run Windows modules from source - -There is currently no single one-click Windows build entry. Build/run by module: - -### 1) desktop-main - -- Path: `platforms/windows/desktop-main/vibe_code_config_tool/` -- Typical dev start: - - `pip install -r requirements.txt` - - `python main.py` - -### 2) ble-bridge - -- Path: `platforms/windows/ble-bridge/BLE_tcp_bridge_for_vibe_code/` -- Typical build: - - Open `BLE_tcp_driver.sln` in Visual Studio and build - - Or build `BLE_tcp_driver.csproj` with .NET Framework 4.7.2 toolchain - -### 3) hook-installer - -- Path: `platforms/windows/hook-installer/vibe_code_hook/` -- Common entry scripts: - - `python hook_install.py` - - `python install_hook.py` - - `python install_cursor_hook.py` - -### 4) speech - -- Path: `platforms/windows/speech/Capswriter/` -- Typical dev start: - - `pip install -r requirements.txt` - - `python start_server.py` - - `python start_client.py` - -## Scope and expectations - -- This repo does **not** include release artifacts like `exe` / `msi`. -- Historical packaging scripts (for example under `platforms/windows/scripts/inno-setup/`) are retained for migration reference and may not be directly reusable as current release pipelines. diff --git a/docs/installation.md b/docs/installation.md index 0e0850e..e4e408e 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -11,6 +11,7 @@ ### Windows desktop-main +- Windows 安装包通过 GitHub Releases 分发；从源码运行或查看模块入口请先看：`platforms/windows/README.md` - 目录：`platforms/windows/desktop-main/vibe_code_config_tool/` - 可判断的开发启动方式： - `pip install -r requirements.txt` diff --git a/platforms/windows/README.md b/platforms/windows/README.md index face085..13127ad 100644 --- a/platforms/windows/README.md +++ b/platforms/windows/README.md @@ -1,5 +1,7 @@ # Windows +安装与发布入口说明见：`docs/installation.md`。 + ## 这个目录是什么 Windows 平台源码的汇总入口。 @@ -24,6 +26,13 @@ Windows 平台源码的汇总入口。 按子目录分别构建，不存在一个已经确认可直接复用的统一总构建入口。 +### 模块 README 入口 + +- `desktop-main/README.md` +- `ble-bridge/README.md` +- `hook-installer/README.md` +- `speech/README.md` + ## GitHub Releases 对应发布物 Windows 安装包和各组件发布产物未来统一通过 GitHub Releases 分发，不保存在本目录中。