You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 3a69b01
Browse filesBrowse the repository at this point in the historyBrowse files
Use [GitHub Issues](https://github.com/breeze0305/UFriend/issues) for reproducible bugs and feature requests. For vulnerabilities, follow [SECURITY.md](SECURITY.md).
4
6
5
7
## Report a problem
@@ -10,6 +12,8 @@ Include the UFriend version, Windows version, local or cloud processing source,
10
12
11
13
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.
12
14
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
+
13
17
1. Follow the [Windows setup guide](docs/guides/INSTALL_BUILD.md). Use `npm ci` to preserve the locked dependency versions.
14
18
2. Use an isolated workspace through `UFRIEND_DATA_DIR`; do not develop against your only copy of personal workspace data.
15
19
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.
Copy file name to clipboardExpand all lines: README.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,15 @@
4
4
5
5
# UFriend
6
6
7
+
[English](README.md) | [繁體中文](README.zh-TW.md)
8
+
7
9
**A Windows workspace for email, recordings, image text, and everyday writing.**
8
10
9
11
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.
10
12
11
13
**Version: 0.1.41 · Windows x64 · Electron 44**
12
14
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)
14
16
15
17
## Features
16
18
@@ -60,7 +62,7 @@ The desktop repository contains HTTP adapters, **not model weights or model-serv
60
62
| PC OCR API |`http://127.0.0.1:8767`| PP-OCRv5 mobile detection and recognition on CPU |
61
63
| PC Whisper API |`http://127.0.0.1:8768`| Multilingual Whisper Small with PyTorch CUDA; Base is optional |
62
64
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.
64
66
65
67
### Cloud AI
66
68
@@ -70,7 +72,7 @@ Text, OCR, and speech have separate defaults, and you can select a source for ea
70
72
71
73
### Gmail
72
74
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.
74
76
75
77
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.
76
78
@@ -107,7 +109,7 @@ For the release format with FFmpeg already inside the single EXE, first prepare
107
109
npm run package:portable -- --with-ffmpeg
108
110
```
109
111
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).
111
113
112
114
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.
113
115
@@ -132,6 +134,8 @@ UGen300 integration is not implemented or verified on hardware. Device-pool timi
132
134
133
135
## Documentation and project files
134
136
137
+
Project documentation is available as separate English (`.md`) and Traditional Chinese (`.zh-TW.md`) files. Each documentation index lists both versions.
138
+
135
139
-[User and developer documentation](docs/README.md)
0 commit comments