diff --git a/README.md b/README.md
index 8ee0e030..b481d9df 100644
--- a/README.md
+++ b/README.md
@@ -1,100 +1,130 @@
- 
+
OpenLess
- Open-source voice input for macOS & Windows.
- Hold a hotkey, talk, and watch AI-polished text stream straight to your cursor โ in the writing style you choose.
+ Open-source voice input for macOS & Windows
- ๐ Official site โ openless.top
+ Hold a hotkey, speak, and watch AI-polished text stream straight to your cursor โ
+ in the writing style you choose.
- English ยท ไธญๆ
+ Website
+ ยท
+ Download
+ ยท
+ English
+ /
+ ไธญๆ
- 
- 
- 
- 
- 
- 
- 
+
+
+
- Join our QQ Group: 1078960553
+ 
+ 
+ 
+ 
- Sponsors
+ ๐ฌ QQ Group 1078960553
+
+
+
+
+Sponsors
+
+
+ OpenLess is sustained by the generous support of its sponsors.
+
+
+
+
+ 
+
+
+
+
+ jiangmuran
+ โญ Featured Sponsor ยท jiangmuran.com
+
+
+
+ Special thanks to jiangmuran for the sustained support that keeps OpenLess moving forward.
+
+
+
+ โ with thanks to โ
- 
-
-
-
-
+
- ๆ ้พไบๆฐๆฎ โ www.knin.net
- ยท
- jiangmuran โ jiangmuran.com
+ ๆ ้พไบๆฐๆฎ ยท Youwu Cloud Data (knin.net)
-
- Developers
-
+Developers
-
-
- 
-
-
-
- 
-
-
-
- 
-
-
- TRIP โ tripmc.top
- ยท
- Chris233 โ chris233.qzz.io
- ยท
- Cooper โ github.com/Cooper-X-Oak
-
+
---
-OpenLess is a cross-platform (macOS & Windows) voice-input app โ a **fully open-source** alternative to commercial tools like [Typeless](https://www.typeless.com/), [Wispr Flow](https://wisprflow.ai), [Lazy](https://heylazy.com), and Superwhisper. Official site: [openless.top](https://openless.top).
+OpenLess is a cross-platform (macOS and Windows) voice-input application โ a fully open-source alternative to commercial tools such as [Typeless](https://www.typeless.com/), [Wispr Flow](https://wisprflow.ai), [Lazy](https://heylazy.com), and Superwhisper. Official site: [openless.top](https://openless.top).
-Put your cursor in any text field โ ChatGPT, Claude, Cursor, Notion, an email draft, a chat box โ press one global hotkey and talk. OpenLess records, transcribes, polishes the text in the mode you picked, and inserts the result at the cursor. If insertion is blocked it copies to the clipboard, so the words you spoke don't get lost.
+Place your cursor in any text field โ ChatGPT, Claude, Cursor, Notion, an email draft, a chat box โ press a single global hotkey, and speak. OpenLess records the audio, transcribes it, polishes the text in the mode you selected, and inserts the result at the cursor. If insertion is blocked, the text is copied to the clipboard instead, so nothing you said is lost.
-Unlike voice typing tools that just dump a word-for-word transcript, OpenLess's headline mode is **AI-prompt mode**: you ramble, it adds structure, lists constraints, and produces a context-rich prompt you can paste straight into ChatGPT / Claude / Cursor.
+Unlike dictation tools that simply emit a word-for-word transcript, OpenLess's headline capability is its **AI-prompt mode**: you speak freely, and it adds structure, captures your constraints, and produces a context-rich prompt that you can paste directly into ChatGPT, Claude, or Cursor.
## โจ What's new
-Two features that change how OpenLess feels day to day:
+Two features define how OpenLess feels in daily use:
-- ๐จ **Style Pack Marketplace.** OpenLess no longer ships a single fixed "polish" voice. Build your own **style packs** with custom system prompts, switch between them with a hotkey, and **install community packs in one click** โ or publish your own to share. When the style is tuned to your exact job (cold emails, commit messages, ๅฐ็บขไนฆ posts, formal reports, your team's tone), the output isn't just cleaner โ it comes out *noticeably better*, because the model is finally writing the way you actually want.
-- โก **Streaming insertion.** Text now flows to your cursor **character by character** as it's polished, instead of making you wait for the whole result to land. Perceived latency drops sharply, so dictation feels about as fast as thinking โ and it automatically falls back to a one-shot paste when an app can't accept streamed keystrokes.
+- ๐จ **Style Pack Marketplace.** OpenLess no longer ships a single fixed "polish" voice. Build your own **style packs** with custom system prompts, switch between them with a hotkey, and **install community packs in one click** โ or publish your own to share. When a style is tuned to your exact task (cold emails, commit messages, ๅฐ็บขไนฆ posts, formal reports, your team's tone), the output is not merely cleaner โ it is *noticeably better*, because the model is finally writing the way you intend.
+- โก **Streaming insertion.** Text now flows to your cursor **character by character** as it is polished, rather than making you wait for the complete result. Perceived latency drops sharply, so dictation feels nearly as fast as thinking โ and it automatically falls back to a one-shot paste when an application cannot accept streamed keystrokes.
## A concrete example
-Hold the hotkey, say to OpenLess:
+Hold the hotkey and say:
> uhโฆ soโฆ I want ChatGPT to write me a SQL query, from the orders table get last month's orders, group by customer, sort by amount desc, top ten
-Release the hotkey. A second later your input box reads:
+Release the hotkey. A moment later, your input box reads:
```text
Please write a SQL query that:
@@ -105,44 +135,44 @@ Please write a SQL query that:
- Returns the top 10 rows only.
```
-No edits needed. Hit Enter and ask GPT. That's the whole pitch: **write prompts with your mouth, faster and cleaner than typing them.**
+No edits are required โ press Enter and send. That is the core idea: **compose prompts by speaking, faster and more cleanly than typing them.**
## Why OpenLess is open source
-The closest tools are subscription SaaS: monthly bill, no bring-your-own model, your audio uploaded to the vendor, your dictionary and habits living in their account.
+The closest alternatives are subscription SaaS products: a monthly fee, no option to bring your own model, your audio uploaded to the vendor, and your dictionary and habits stored in their account.
-OpenLess goes for the same end-user experience but:
+OpenLess targets the same end-user experience, but:
-- **Fully open source, local-first.** Code is in this repo; all your data stays on your machine.
-- **Bring your own cloud credentials.** Volcengine streaming ASR + Ark / DeepSeek-compatible chat-completions. No vendor lock-in.
-- **Tuned for AI prompts.** The "Structured" mode reshapes loose speech into a prompt with context, constraints, and asks โ paste straight into ChatGPT, Claude, or Cursor.
-- **Won't answer for you.** The model only cleans up your text. If you say "what features does this app still need?", it returns that as a clean question โ it does not hand you a feature list. Ask the real AI for that.
+- **Fully open source, local-first.** The code lives in this repository, and all of your data stays on your machine.
+- **Bring your own cloud credentials.** Volcengine streaming ASR with Ark / DeepSeek-compatible chat completions. No vendor lock-in.
+- **Tuned for AI prompts.** The structured mode reshapes loose speech into a prompt complete with context, constraints, and requests โ ready to paste into ChatGPT, Claude, or Cursor.
+- **It will not answer for you.** The model only cleans up your text. If you say "what features does this app still need?", it returns that as a clean question โ it does not hand you a feature list. For that, ask the AI itself.
## Use cases
-- Writing prompts for ChatGPT / Claude / Cursor / Gemini: dictate a request, OpenLess turns it into a structured, detailed prompt.
-- Drafting emails, specs, long Slack/WeChat messages: removes filler, fixes punctuation, organizes paragraphs.
-- Code comments, commit messages, PR descriptions: dump what's in your head straight to the cursor.
-- Any "I don't want to type but I have to produce written text" situation.
+- **Writing prompts for ChatGPT / Claude / Cursor / Gemini** โ dictate a request and OpenLess turns it into a structured, detailed prompt.
+- **Drafting emails, specifications, and long Slack or WeChat messages** โ filler is removed, punctuation is corrected, and paragraphs are organized.
+- **Code comments, commit messages, and PR descriptions** โ capture your thoughts directly at the cursor.
+- **Any situation** where you must produce written text but would rather not type.
## Style packs & the Marketplace
-A **style pack** is a named output style with its own system prompt. Instead of being stuck with one built-in "polish" voice, you can shape exactly how your speech comes out โ and the closer the style matches your real task, the better the result.
+A **style pack** is a named output style with its own system prompt. Rather than being constrained to one built-in "polish" voice, you can shape exactly how your speech is rendered โ and the closer the style matches your real task, the better the result.
-- **Create & customize.** On the **Style** page, add a pack and write a custom system prompt (e.g. "terse engineering commit messages", "warm customer-support replies", "ๅฐ็บขไนฆ copy with emoji"). Switch the active pack with a hotkey.
-- **Install from the community.** Open the **Marketplace** to browse, search, and one-click install packs other people have shared, and like the ones that work for you.
-- **Publish your own.** Sign in with a GitHub identity (Settings โ Marketplace), then hit **Publish to Marketplace** from the Style page. Uploads are moderated before they appear publicly.
+- **Create and customize.** On the **Style** page, add a pack and write a custom system prompt (for example, "terse engineering commit messages", "warm customer-support replies", or "ๅฐ็บขไนฆ copy with emoji"). Switch the active pack with a hotkey.
+- **Install from the community.** Open the **Marketplace** to browse, search, and install packs others have shared in one click, and like the ones that work for you.
+- **Publish your own.** Sign in with a GitHub identity (Settings โ Marketplace), then select **Publish to Marketplace** from the Style page. Uploads are moderated before they appear publicly.
-The marketplace is served by OpenLess's own moderated backend, so the catalog stays curated rather than a free-for-all.
+The marketplace is served by OpenLess's own moderated backend, so the catalog remains curated rather than a free-for-all.
## Project direction
-OpenLess does one thing: **turn speech into usable written text (especially AI prompts), at the current cursor.**
+OpenLess does one thing: it **turns speech into usable written text โ AI prompts in particular โ at the current cursor.**
- It does not answer questions, run tasks, or analyze your project.
-- It does not accumulate conversation context โ every dictation is an independent cleanup request.
-- Speech โ transcript โ cleanup โ insert at cursor. Clipboard fallback on failure.
-- Everything else (modes, dictionary, history, menu bar, home report) supports that one path.
+- It does not accumulate conversation context; every dictation is an independent cleanup request.
+- The pipeline is: speech โ transcript โ cleanup โ insertion at the cursor, with a clipboard fallback on failure.
+- Everything else (modes, dictionary, history, menu bar, home report) exists to support that single path.
## Comparison
@@ -155,33 +185,34 @@ OpenLess does one thing: **turn speech into usable written text (especially AI p
## Status (v1.3.6)
-- Tauri 2 + Rust backend + React/TS frontend. macOS 12+, Windows 10+.
+- Tauri 2 backend in Rust with a React/TypeScript frontend. macOS 12+, Windows 10+.
- ๐จ **Style Pack Marketplace** โ browse, install, and like community **style packs** from the in-app Marketplace, and publish your own (custom system prompt per pack, switchable by hotkey). Backed by a moderated marketplace backend; uploads are reviewed before they go public.
-- โก **Streaming insertion** โ polished text is written to the cursor character by character to cut perceived latency, with an automatic one-shot-paste fallback. Toggle in Settings โ Recording.
-- **Toggle and push-to-talk** recording modes, plus a **MediaPlayPause trigger** so wired-earbud inline controls can start/stop recording. `Esc` cancels at any phase, including polish/insert.
+- โก **Streaming insertion** โ polished text is written to the cursor character by character to reduce perceived latency, with an automatic one-shot-paste fallback. Toggle in Settings โ Recording.
+- **Toggle and push-to-talk** recording modes, plus a **MediaPlayPause trigger** so wired-earbud inline controls can start and stop recording. `Esc` cancels at any phase, including polish and insertion.
- **Cloud ASR**: Volcengine streaming ASR, OpenAI Whisper-compatible batch ASR, Apple Speech (macOS).
- **Local ASR**: bundled Qwen3-ASR (0.6B / 1.7B) via vendored `Open-Less/qwen-asr`; Windows Foundry Local Whisper variants.
-- **Polish providers**: Ark / DeepSeek / OpenAI / Doubao / Anthropic-compatible chat-completions, plus any OpenAI-compatible endpoint you bring.
-- 4 output modes: raw, light polish, structured (**AI prompt mode**), formal. Plus a **translation hotkey** that converts speech directly into the configured target language ([#43](../../issues/43)).
-- **Selection-ask QA panel** โ separate hotkey opens a floating panel that runs voice Q&A against the highlighted text in any app ([#118](../../issues/118)).
-- Main window: Overview / History / Vocab / Style / Marketplace / Settings. Persistent tray icon. Mini status capsule that floats on screen and follows the display you're typing on (multi-monitor).
+- **Polish providers**: Ark / DeepSeek / OpenAI / Doubao / Anthropic-compatible chat completions, plus any OpenAI-compatible endpoint you bring.
+- **Four output modes**: raw, light polish, structured (**AI-prompt mode**), and formal. Plus a **translation hotkey** that converts speech directly into the configured target language ([#43](../../issues/43)).
+- **Selection-ask QA panel** โ a separate hotkey opens a floating panel that runs voice Q&A against the highlighted text in any app ([#118](../../issues/118)).
+- **Main window**: Overview / History / Vocab / Style / Marketplace / Settings. Persistent tray icon, plus a mini status capsule that floats on screen and follows the display you are typing on (multi-monitor).
- **Local model management** โ manage on-disk local-ASR model storage from Settings.
-- **Multilingual UI** โ Settings โ Language switches between ็ฎไฝไธญๆ / ็น้ซไธญๆ / English / ๆฅๆฌ่ช / ํ๊ตญ์ด (auto-detects on first launch).
-- **In-app auto-update** โ Settings โ About โ Check button; signed updater artifacts via Tauri updater plugin.
-- **Beta channel (opt-in)** โ Settings โ About โ Join Beta channel exposes the latest pre-release build for manual download; Beta releases never reach Stable users automatically (see [Contributing workflow](#contributing-workflow)).
-- **Distribution channels** โ direct DMG/EXE from [Releases](../../releases), Homebrew Cask (`brew install --cask openless`), Windows installer.
+- **Multilingual UI** โ Settings โ Language switches between ็ฎไฝไธญๆ / ็น้ซไธญๆ / English / ๆฅๆฌ่ช / ํ๊ตญ์ด (auto-detected on first launch).
+- **In-app auto-update** โ Settings โ About โ Check; signed updater artifacts via the Tauri updater plugin.
+- **Beta channel (opt-in)** โ Settings โ About โ Join Beta channel exposes the latest pre-release build for manual download. Beta releases never reach Stable users automatically (see [Contributing workflow](#contributing-workflow)).
+- **Distribution channels** โ direct DMG/EXE from [Releases](../../releases), Homebrew Cask (`brew install --cask openless`), and a Windows installer.
- **Single-instance lock** โ prevents two OpenLess processes from racing the same hotkey edge.
-- Dictionary entries injected as Volcengine ASR `context.hotwords` and as semantic hints during polish; hits accumulate per session.
+- Dictionary entries are injected as Volcengine ASR `context.hotwords` and as semantic hints during polish; hits accumulate per session.
- Platform-native global hotkey: CGEventTap on macOS, low-level keyboard hook (`WH_KEYBOARD_LL`) on Windows.
## Download & install (end users)
Go to [Releases](../../releases) and download:
-- **macOS**: `OpenLess__aarch64.dmg` (Apple Silicon) or `OpenLess__x64.dmg` (Intel) โ open, drag to `/Applications`, **then run this once in Terminal to bypass Gatekeeper "damaged" warning** (the build is ad-hoc signed, not Apple-notarized):
+
+- **macOS**: `OpenLess__aarch64.dmg` (Apple Silicon) or `OpenLess__x64.dmg` (Intel). Open it, drag the app to `/Applications`, **then run the following once in Terminal to bypass the Gatekeeper "damaged" warning** (the build is ad-hoc signed, not Apple-notarized):
```bash
xattr -cr /Applications/OpenLess.app
```
-- **Windows**: `OpenLess__x64-setup.exe` โ run the installer
+- **Windows**: `OpenLess__x64-setup.exe` โ run the installer.
- **macOS (Homebrew)**:
```bash
brew tap appergb/openless https://github.com/appergb/openless
@@ -192,24 +223,24 @@ Go to [Releases](../../releases) and download:
brew update && brew upgrade openless
```
-On first launch, grant the permissions the app requests:
+On first launch, grant the permissions the app requests.
**macOS:**
1. Grant Microphone access.
2. Grant Accessibility access.
3. **Quit and reopen the app** โ Accessibility only takes effect after a restart.
-4. Open Settings โ fill in Volcengine ASR + Ark credentials.
+4. Open Settings and fill in your Volcengine ASR + Ark credentials.
**Windows:**
1. Grant Microphone access when prompted.
2. Open Settings โ Permissions to verify the global hotkey listener is active.
-3. Fill in Volcengine ASR + Ark credentials in Settings.
+3. Fill in your Volcengine ASR + Ark credentials in Settings.
-Full end-user walkthrough: [USAGE.md](USAGE.md).
+For the full end-user walkthrough, see [USAGE.md](USAGE.md).
## Build from source (developers)
-The active codebase is in `openless-all/app/` (Tauri 2 + Rust + React/TS). The macOS build links a vendored C ASR engine ([`Open-Less/qwen-asr`](https://github.com/Open-Less/qwen-asr), forked from `antirez/qwen-asr`) pulled in as a git submodule under `src-tauri/vendor/qwen-asr/`, so initialize submodules on first clone.
+The active codebase lives in `openless-all/app/` (Tauri 2 + Rust + React/TS). The macOS build links a vendored C ASR engine ([`Open-Less/qwen-asr`](https://github.com/Open-Less/qwen-asr), forked from `antirez/qwen-asr`) pulled in as a git submodule under `src-tauri/vendor/qwen-asr/`, so initialize submodules on first clone.
```bash
# First clone only โ pull in vendored submodules
@@ -225,7 +256,7 @@ npm run tauri dev
./scripts/build-mac.sh
INSTALL=0 ./scripts/build-mac.sh # build only, skip install
-# Rust type-check without full compile
+# Rust type-check without a full compile
cargo check --manifest-path src-tauri/Cargo.toml
# Frontend TS check
@@ -234,14 +265,14 @@ npm run build
Logs: `~/Library/Logs/OpenLess/openless.log` (macOS) / `%LOCALAPPDATA%\OpenLess\Logs\openless.log` (Windows).
-**Windows build** โ see [`openless-all/README.md`](openless-all/README.md) for MSVC vs GNU/MinGW routes.
+**Windows build** โ see [`openless-all/README.md`](openless-all/README.md) for the MSVC and GNU/MinGW routes.
## Contributing workflow
OpenLess uses a two-channel branching model.
-- **`beta`** โ the **Beta channel**. Default branch and integration buffer; all in-progress development lands here. Beta builds may exist but are **not pushed to regular users** โ they only reach people who explicitly opt into the Beta channel.
-- **`main`** โ the **Stable channel (ๆญฃๅผ็)**. Always-releasable. The build everyone gets by default.
+- **`beta`** โ the **Beta channel**. The default branch and integration buffer; all in-progress development lands here. Beta builds may exist but are **not pushed to regular users** โ they reach only those who explicitly opt into the Beta channel.
+- **`main`** โ the **Stable channel (ๆญฃๅผ็)**. Always releasable; the build everyone receives by default.
```text
your fork / topic branch
@@ -259,17 +290,17 @@ your fork / topic branch
Rules of thumb:
- **Open PRs against `beta`, never against `main`.** GitHub already defaults the base branch to `beta` for new PRs.
-- **Verify the change on your target platform before opening the PR** โ build green is necessary, manual verification is required.
-- **AI review runs once per PR and is advisory.** Don't loop on it. Apply your judgment.
+- **Verify the change on your target platform before opening the PR** โ a green build is necessary, and manual verification is required.
+- **AI review runs once per PR and is advisory.** Do not loop on it; apply your own judgment.
- **Keep AI rework rounds tight (1โ2).** If a fix resists, ask a human or restart with fresh context โ multi-round AI back-and-forth tends to do more harm than good here.
-- **Beta work must not leak to Stable.** `main` only receives merges from `beta`, performed by maintainers after a successful two-platform smoke build. No direct pushes to `main`.
+- **Beta work must not leak to Stable.** `main` receives merges only from `beta`, performed by maintainers after a successful two-platform smoke build. No direct pushes to `main`.
- **Stable releases are cut from `main`** by pushing a `v-tauri` tag โ see the maintainer release checklist below.
-Beta release distribution (manual-download opt-in): the in-app updater always reads the Stable manifest, so regular users never get Beta builds via auto-update. Users who want to try Beta open **Settings โ About**, flip "Join Beta channel", and download the latest Beta installer manually from the link the app fetches from GitHub. Tag convention: `v-beta-tauri` produces the Beta release (marked GitHub pre-release; manifest written as `latest-{tgt}-{arch}-beta.json`); `v-tauri` produces the Stable release. The two manifest files never overlap, so Stable users' updater feed cannot pick up Beta releases.
+Beta release distribution (manual-download opt-in): the in-app updater always reads the Stable manifest, so regular users never receive Beta builds via auto-update. Users who want to try Beta open **Settings โ About**, enable "Join Beta channel", and download the latest Beta installer manually from the link the app fetches from GitHub. Tag convention: `v-beta-tauri` produces the Beta release (marked as a GitHub pre-release; manifest written as `latest-{tgt}-{arch}-beta.json`), while `v-tauri` produces the Stable release. The two manifest files never overlap, so Stable users' updater feed cannot pick up Beta releases.
## Credentials
-Credentials live in the OS credential vault (service = `com.openless.app`): macOS Keychain, Windows Credential Manager, or Linux keyring. A legacy plaintext JSON file is read only as a migration source and removed after a successful vault write:
+Credentials live in the OS credential vault (service = `com.openless.app`): macOS Keychain, Windows Credential Manager, or the Linux keyring. A legacy plaintext JSON file is read only as a migration source and removed after a successful vault write:
```text
macOS / Linux: ~/.openless/credentials.json
@@ -278,18 +309,18 @@ Windows: %APPDATA%\OpenLess\credentials.json
New credential writes do not persist plaintext secrets. The repository contains no API keys, tokens, or private endpoints.
-You'll need:
+You will need:
- **Volcengine streaming ASR**: APP ID, Access Token, Resource ID.
-- **Ark polish**: API Key, Model ID, Endpoint. Ark default endpoint is `https://ark.cn-beijing.volces.com/api/v3/chat/completions`.
+- **Ark polish**: API Key, Model ID, Endpoint. The Ark default endpoint is `https://ark.cn-beijing.volces.com/api/v3/chat/completions`.
## Prompt-handling principles
-OpenLess's polish model only reshapes text. It does not answer questions, run tasks, or analyze your project. Each dictation is an independent request, and the prompt explicitly tells the model:
+OpenLess's polish model only reshapes text. It does not answer questions, run tasks, or analyze your project. Each dictation is an independent request, and the prompt explicitly instructs the model:
- This input is isolated from any prior conversation.
- The raw transcript is text to clean up, not a question to answer.
-- Even if the input contains a question or a command, do not reply or execute.
+- Even if the input contains a question or a command, do not reply or execute it.
- Output the cleaned text only โ no "Here's the cleaned version" preamble.
For example, if the user says "what features does this app still need", the correct output is:
@@ -306,16 +337,16 @@ Long-term reference rewrites are stored as `raw โ polished โ rule` triples a
The dictionary handles your proper nouns, product names, names of people, and new words. Today it supports:
-- Manually add the correct spelling, a category, and notes. You don't need to maintain misspellings or context hints.
-- Enabled entries are sent as Volcengine ASR `context.hotwords` so they're recognized correctly during transcription.
-- Entries are also injected into the polish prompt: the model decides per-sentence whether to substitute. If "Cloud" clearly refers to the AI product `Claude` in context, it gets corrected. If it really means cloud computing, it stays.
-- The app auto-learns candidate corrections like `Claude`, `ChatGPT`, `OpenLess` from your history and offers them up later.
+- Manually adding the correct spelling, a category, and notes. You do not need to maintain misspellings or context hints.
+- Enabled entries are sent as Volcengine ASR `context.hotwords` so they are recognized correctly during transcription.
+- Entries are also injected into the polish prompt: the model decides per sentence whether to substitute. If "Cloud" clearly refers to the AI product `Claude` in context, it is corrected; if it genuinely means cloud computing, it is left as is.
+- The app auto-learns candidate corrections such as `Claude`, `ChatGPT`, and `OpenLess` from your history and offers them later.
-The main window is organized as Home / History / Dictionary / Settings. The Dictionary tab opens a separate editor window when you click "New". The Home tab shows total dictation time, total characters, average chars-per-minute, estimated time saved, and dictionary participation stats.
+The main window is organized as Home / History / Dictionary / Settings. The Dictionary tab opens a separate editor window when you click "New". The Home tab shows total dictation time, total characters, average characters per minute, estimated time saved, and dictionary participation statistics.
## Architecture
-The active implementation is Tauri 2 (`openless-all/app/`). Releases are split into two channels: **Stable** (`v-tauri` tag, auto-updated to all users) and **Beta** (`v-beta-tauri` tag, GitHub pre-release, manually downloaded by opt-in users). Signed updater artifacts are produced by CI on every release tag.
+The active implementation is Tauri 2 (`openless-all/app/`). Releases are split into two channels: **Stable** (`v-tauri` tag, auto-updated for all users) and **Beta** (`v-beta-tauri` tag, GitHub pre-release, manually downloaded by opt-in users). Signed updater artifacts are produced by CI on every release tag.
**Tauri backend (Rust)** โ each module depends only on `types.rs`:
@@ -324,7 +355,7 @@ types.rs Pure value types: DictationSession, PolishMode, HotkeyBinding,
hotkey.rs Global hotkey (CGEventTap on macOS, WH_KEYBOARD_LL on Windows, rdev on Linux)
recorder.rs Mic โ 16 kHz mono Int16 PCM, RMS callback
asr/ Volcengine streaming ASR (WebSocket) + Whisper HTTP
-polish.rs OpenAI-compatible chat-completions (Ark / DeepSeek / etc.)
+polish.rs OpenAI-compatible chat completions (Ark / DeepSeek / etc.)
insertion.rs AX focused-element โ clipboard + Cmd+V โ copy-only fallback
persistence.rs History / preferences / vocab JSON + platform credential vault
permissions.rs TCC checks (Accessibility / Microphone)
@@ -332,7 +363,7 @@ coordinator.rs State machine: Idle โ Starting โ Listening โ Processing
commands.rs Tauri IPC surface
```
-**React frontend (`src/`)** โ state via Recoil atoms (`pages/_atoms.tsx`); hotkey capability/binding via `HotkeySettingsContext`; all backend calls go through `lib/ipc.ts`.
+**React frontend (`src/`)** โ state via Recoil atoms (`pages/_atoms.tsx`); hotkey capability and binding via `HotkeySettingsContext`; all backend calls go through `lib/ipc.ts`.
The dictation pipeline: `hotkey edge โ Recorder.start + ASR.openSession โ [audio frames] โ hotkey edge โ Recorder.stop + ASR.sendLastFrame โ Polish โ Insert โ History.save`.
@@ -342,50 +373,50 @@ See [CLAUDE.md](CLAUDE.md) for invariants and module-wiring rules.
Planned but not yet shipped:
-- Dictation translation mode: hold a separate hotkey, speak in your language, insert in target language ([#43](../../issues/43)).
-- Cross-session style memory: polish learns user's tone over time ([#46](../../issues/46)).
-- Snippets (no UI / trigger logic yet).
+- Dictation translation mode: hold a separate hotkey, speak in your language, insert in the target language ([#43](../../issues/43)).
+- Cross-session style memory: polish learns the user's tone over time ([#46](../../issues/46)).
+- Snippets (no UI or trigger logic yet).
- History enhancements: copy button, search, re-polish, re-insert.
-- "Paste last result" hotkey.
+- A "Paste last result" hotkey.
## Maintainer release checklist
-OpenLess ships two release channels. Branch name = channel name (see [Contributing workflow](#contributing-workflow)).
+OpenLess ships two release channels. The branch name equals the channel name (see [Contributing workflow](#contributing-workflow)).
### Common prep (both channels)
-- Bump version in **all five** files: `package.json`, `package-lock.json` (root + nested entry under `packages.""`), `src-tauri/tauri.conf.json`, `src-tauri/Cargo.toml`, `Cargo.lock` (look for the `name = "openless"` block). CI's `Verify version sync` step will fail the build otherwise.
+- Bump the version in **all five** files: `package.json`, `package-lock.json` (root + nested entry under `packages.""`), `src-tauri/tauri.conf.json`, `src-tauri/Cargo.toml`, and `Cargo.lock` (look for the `name = "openless"` block). CI's `Verify version sync` step will otherwise fail the build.
- Run `INSTALL=0 ./scripts/build-mac.sh` and confirm the `.app` launches.
-- Smoke-test on a clean machine: permission flow, hotkey, recording, ASR, polish, insertion, clipboard fallback.
-- Confirm `TAURI_SIGNING_PRIVATE_KEY` and (for macOS) the Apple signing/notarization secrets are set on the repo.
+- Smoke-test on a clean machine: permission flow, hotkey, recording, ASR, polish, insertion, and clipboard fallback.
+- Confirm that `TAURI_SIGNING_PRIVATE_KEY` and (for macOS) the Apple signing/notarization secrets are set on the repo.
### Beta channel โ `v-beta-tauri`
1. Land changes onto the `beta` branch via PR review.
-2. Push tag **on `beta`**: `git tag v-beta-tauri && git push origin v-beta-tauri`.
-3. CI tags the GitHub Release as `Pre-release` and uploads only `latest-{tgt}-{arch}-beta.json` updater manifests. Stable users' `releases/latest` redirect is unaffected.
+2. Push the tag **on `beta`**: `git tag v-beta-tauri && git push origin v-beta-tauri`.
+3. CI tags the GitHub Release as `Pre-release` and uploads only `latest-{tgt}-{arch}-beta.json` updater manifests. The Stable users' `releases/latest` redirect is unaffected.
4. Announce in the appropriate channel (issue thread, QQ group) that opt-in Beta users can grab it from Settings โ About โ Join Beta channel.
### Stable channel โ `v-tauri`
-1. Merge `beta โ main` after the Beta release has soaked enough (or run a final two-platform smoke build directly).
-2. Push tag **on `main`**: `git tag v-tauri && git push origin v-tauri`.
-3. CI publishes a normal GitHub Release and uploads `latest-{tgt}-{arch}.json` (no `-beta` suffix). All Stable users get the update through the in-app updater.
+1. Merge `beta โ main` after the Beta release has soaked sufficiently (or run a final two-platform smoke build directly).
+2. Push the tag **on `main`**: `git tag v-tauri && git push origin v-tauri`.
+3. CI publishes a normal GitHub Release and uploads `latest-{tgt}-{arch}.json` (no `-beta` suffix). All Stable users receive the update through the in-app updater.
### Post-release verification (always run)
-Run the 5-step checklist in [`CLAUDE.md` โ Branch & release-channel workflow โ Channel distribution](CLAUDE.md): page status (pre-release flag), asset filename channel-correctness, Stable user flow, Beta opt-in flow, raw endpoint sanity.
+Run the 5-step checklist in [`CLAUDE.md` โ Branch & release-channel workflow โ Channel distribution](CLAUDE.md): page status (pre-release flag), asset-filename channel correctness, Stable user flow, Beta opt-in flow, and raw endpoint sanity.
## Acknowledgements
-OpenLess sincerely thanks our sponsors, developers/contributors, and the broader LinuxDo community.
+OpenLess sincerely thanks its sponsors, developers and contributors, and the broader LinuxDo community.
-We appreciate sponsors for making sustained project work possible, and we thank developers and contributors for building, reviewing, and improving OpenLess.
+We appreciate our sponsors for making sustained project work possible, and we thank our developers and contributors for building, reviewing, and improving OpenLess.
-OpenLess also recognizes and appreciates the LinuxDo community for its open, practical, and developer-friendly atmosphere. Many ideas, discussions, and early feedback around OpenLess were inspired by the broader open-source spirit represented by LinuxDo.
+OpenLess also recognizes and appreciates the LinuxDo community for its open, practical, and developer-friendly atmosphere. Many of the ideas, discussions, and early feedback around OpenLess were inspired by the broader open-source spirit that LinuxDo represents.
This acknowledgement does not imply official endorsement or affiliation.
## License
-MIT
+OpenLess is released under the [MIT License](LICENSE).