Skip to content

Commit 3a69b01

Browse files
committed
docs: provide English and Traditional Chinese documentation
1 parent 8c85eb5 commit 3a69b01

37 files changed

Lines changed: 3012 additions & 600 deletions

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ yarn-error.log*
2828
/docs/product/
2929
/docs/development/*
3030
!/docs/development/FFMPEG_RUNTIME.md
31+
!/docs/development/FFMPEG_RUNTIME.zh-TW.md
3132
!/docs/development/MEDIA_RUNTIME_BUILD.md
33+
!/docs/development/MEDIA_RUNTIME_BUILD.zh-TW.md
3234

3335
# Keep only the artwork required by the icon build
3436
/design/logo-options/*

‎CONTRIBUTING.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Contributing to UFriend
22

3+
[English](CONTRIBUTING.md) | [繁體中文](CONTRIBUTING.zh-TW.md)
4+
35
Use [GitHub Issues](https://github.com/breeze0305/UFriend/issues) for reproducible bugs and feature requests. For vulnerabilities, follow [SECURITY.md](SECURITY.md).
46

57
## Report a problem
@@ -10,6 +12,8 @@ Include the UFriend version, Windows version, local or cloud processing source,
1012

1113
Discuss larger changes in an issue before implementing them. Keep changes focused, explain the resulting behavior, and update the relevant documentation. Contributions to the project's own code are provided under the [MIT License](LICENSE); retain the licenses and attribution of any third-party material you add.
1214

15+
Maintain separate English (`NAME.md`) and Traditional Chinese (`NAME.zh-TW.md`) versions of every project explanation. Update both versions together, keep their commands, facts, and limitations consistent, add language links, and list new documentation in both `docs/README.md` and `docs/README.zh-TW.md`. Preserve upstream license texts and hash-pinned runtime metadata byte for byte; provide a separate translation and link it from the documentation indexes instead of editing a pinned original.
16+
1317
1. Follow the [Windows setup guide](docs/guides/INSTALL_BUILD.md). Use `npm ci` to preserve the locked dependency versions.
1418
2. Use an isolated workspace through `UFRIEND_DATA_DIR`; do not develop against your only copy of personal workspace data.
1519
3. Run `npm run check` and tests appropriate to the change. Run `npm test` before submitting, and report any skipped media checks. UI or native changes may also require the smoke tests described in the guide.

‎CONTRIBUTING.zh-TW.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# 參與 UFriend 貢獻
2+
3+
[English](CONTRIBUTING.md) | [繁體中文](CONTRIBUTING.zh-TW.md)
4+
5+
可重現的錯誤與功能需求請使用 [GitHub Issues](https://github.com/breeze0305/UFriend/issues)提出。安全漏洞請依[安全問題回報方式](SECURITY.zh-TW.md)處理。
6+
7+
## 回報問題
8+
9+
請提供 UFriend 版本、Windows 版本、使用本地或雲端處理來源、重現步驟、預期行為與實際結果。優先提供少量合成的 EML、圖片或錄音,避免使用個人資料。分享前檢查截圖與紀錄,移除帳號資訊、API 金鑰、OAuth 檔案、郵件內容及私人路徑。
10+
11+
## 提出修改
12+
13+
較大的變更請先在 issue 討論。讓修改範圍集中、說明修改後的行為,並更新相關文件。對專案自有程式碼的貢獻以 [MIT 授權](LICENSE)提供;加入第三方素材時,保留其授權及來源註記。
14+
15+
每份專案說明都須分別提供英文(`NAME.md`)與繁體中文(`NAME.zh-TW.md`)檔案。兩版應同時更新,保持指令、事實與限制一致,加入語言切換連結,並在 `docs/README.md` 與 `docs/README.zh-TW.md` 都列出新增文件。上游授權原文與固定雜湊的影音元件中繼資料須逐位元保留;請另外提供翻譯並從文件目錄連結,不直接修改受校驗的原檔。
16+
17+
1. 依 [Windows 安裝指南](docs/guides/INSTALL_BUILD.zh-TW.md)準備環境,使用 `npm ci` 保持固定的依賴版本。
18+
2. 透過 `UFRIEND_DATA_DIR` 使用隔離工作空間,不要直接在唯一一份個人工作資料上開發。
19+
3. 執行 `npm run check` 及適合本次修改的測試。提交貢獻前執行 `npm test`,並回報跳過的影音檢查。UI 或原生元件修改可能也需要指南列出的 smoke 測試。
20+
4. 在 pull request 說明問題、行為變更、驗證方式及剩餘限制。涉及介面時,一併更新英文與繁體中文。
21+
22+
不要加入憑證、OAuth 下載檔、個人郵件、錄音、模型權重、依賴資料夾、發布套件或測試輸出。`app/config/google-oauth.json` 必須維持空白範本。PC 模型服務是獨立專案,相關變更應提交到各自的 repository。
23+
24+
建置與打包細節,包括 FFmpeg 前置需求,見[安裝指南](docs/guides/INSTALL_BUILD.zh-TW.md)。`npm run package:portable` 使用固定版本的 electron-builder 工具鏈建置單一 EXE,不會發布版本。修改單檔啟動器或影音元件安裝器時,應檢查重新啟動、資料持續保存,以及失敗時保留既有檔案的行為。成功打包不能取代工作流程測試。

‎README.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@
44

55
# UFriend
66

7+
[English](README.md) | [繁體中文](README.zh-TW.md)
8+
79
**A Windows workspace for email, recordings, image text, and everyday writing.**
810

911
UFriend keeps your workspace on your computer and connects to separately configured local or cloud AI services. Review the original material alongside the result, edit it, and decide how to use it. The interface supports English and Traditional Chinese, with light, dark, and system themes.
1012

1113
**Version: 0.1.41 · Windows x64 · Electron 44**
1214

13-
[Releases](https://github.com/breeze0305/UFriend/releases) · [Documentation](docs/README.md) · [使用手冊(繁體中文)](docs/guides/APP_README.md) · [Report an issue](https://github.com/breeze0305/UFriend/issues)
15+
[Releases](https://github.com/breeze0305/UFriend/releases) · [Documentation](docs/README.md) · [User manual](docs/guides/APP_README.md) · [Report an issue](https://github.com/breeze0305/UFriend/issues)
1416

1517
## Features
1618

@@ -60,7 +62,7 @@ The desktop repository contains HTTP adapters, **not model weights or model-serv
6062
| PC OCR API | `http://127.0.0.1:8767` | PP-OCRv5 mobile detection and recognition on CPU |
6163
| PC Whisper API | `http://127.0.0.1:8768` | Multilingual Whisper Small with PyTorch CUDA; Base is optional |
6264

63-
Install and start each required service using its own README. In the local model settings, select PC API, save the endpoints, and test the connections. Only loopback endpoints are supported for these services. UFriend does not install, start, or stop them. See the [PC model guide](docs/guides/PC_MODELS.md) for requirements.
65+
Install and start each required service using its own README. In **Settings → Models and compute → Local models**, select **PC local services** under **Local backend**, save the endpoints, and test the connections. Only loopback endpoints are supported for these services. UFriend does not install, start, or stop them. See the [PC model guide](docs/guides/PC_MODELS.md) for requirements.
6466

6567
### Cloud AI
6668

@@ -70,7 +72,7 @@ Text, OCR, and speech have separate defaults, and you can select a source for ea
7072

7173
### Gmail
7274

73-
Bring your own **Google Desktop OAuth client configuration**. Enable Gmail API in your Google Cloud project, configure its consent screen and permitted users, then import the downloaded Desktop client JSON in **Settings → Email accounts → Advanced settings**. Follow the [Gmail setup guide](docs/guides/GMAIL_SETUP_GUIDE.md), then authorize your account in the system browser.
75+
Bring your own **Google Desktop OAuth client configuration**. Enable Gmail API in your Google Cloud project, configure its consent screen and permitted users, then import the downloaded Desktop client JSON in **Settings → Email accounts → Advanced settings (developers)**. Follow the [Gmail setup guide](docs/guides/GMAIL_SETUP_GUIDE.md), then authorize your account in the system browser.
7476

7577
The repository and public release contain an empty OAuth template; no shared client or Gmail credentials are supplied. EML import and local drafts can be used without a Gmail connection. Connected mail currently supports Gmail only.
7678

@@ -107,7 +109,7 @@ For the release format with FFmpeg already inside the single EXE, first prepare
107109
npm run package:portable -- --with-ffmpeg
108110
```
109111

110-
This also creates `UFriend-<version>.exe`, in its own build directory. The build receipt records whether FFmpeg is included. A bundled runtime takes precedence over an older optional installation in user data. The executable includes the GPL license, third-party notices, and source information. Publish the matching complete source archive alongside the EXE; a successful binary build alone does not complete this step. See the [runtime guide](docs/development/FFMPEG_RUNTIME.md#授權與來源紀錄).
112+
This also creates `UFriend-<version>.exe`, in its own build directory. The build receipt records whether FFmpeg is included. A bundled runtime takes precedence over an older optional installation in user data. The executable includes the GPL license, third-party notices, and source information. Publish the matching complete source archive alongside the EXE; a successful binary build alone does not complete this step. See the [runtime guide](docs/development/FFMPEG_RUNTIME.md).
111113

112114
To create only the folder package for ZIP distribution, use `npm run package -- --without-ffmpeg`. For a local folder package using the prepared FFmpeg runtime, use `npm run package`. Packaging does not run the full test suite or publish a release. See the [installation guide](docs/guides/INSTALL_BUILD.md) for isolated development data, UI smoke tests, prerequisites, and packaging details.
113115

@@ -132,6 +134,8 @@ UGen300 integration is not implemented or verified on hardware. Device-pool timi
132134

133135
## Documentation and project files
134136

137+
Project documentation is available as separate English (`.md`) and Traditional Chinese (`.zh-TW.md`) files. Each documentation index lists both versions.
138+
135139
- [User and developer documentation](docs/README.md)
136140
- [Model adapter contracts](app/models/README.md)
137141
- [Windows clipboard component](app/native/README.md)

0 commit comments

Comments
 (0)