diff --git a/README.md b/README.md index d0acd92..bf47e26 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Native C++20 / Win32 rewrite of the Windows functionality of [Typlo](https://github.com/bitcodepro/Typlo). Windows 10/11 x64. No .NET, Avalonia, WebView, Qt, external graphics engine, or separately installed C++ runtime. -The original Typlo project and its data remain separate. +The original [Typlo](https://github.com/bitcodepro/Typlo) project and its data remain separate. **[User guide / Wiki](https://gitea.hrynco.com/hrynco/hrynco-kswitcher/wiki)** — setup, features, shortcuts, dictionaries, screenshots and troubleshooting (Ukrainian). @@ -19,7 +19,7 @@ the task runs in the signed-in user's interactive session, including on battery Disabling the administrator option restores ordinary per-user startup; disabling startup stops future automatic launches. Saving unrelated settings does not recreate startup entries. `KSwitcher.exe --settings` opens Settings, including when the app is already running. -Exit Typlo when using overlapping shortcuts to avoid competing keyboard hooks. +Exit [Typlo](https://github.com/bitcodepro/Typlo) when using overlapping shortcuts to avoid competing keyboard hooks. ### Change a shortcut @@ -47,7 +47,7 @@ Ctrl+Alt+Delete and Win+L; these cannot be assigned. - Clipboard snapshot/restoration with concurrent-copy, foreground and input-version checks. - Case cycling, Russian/Ukrainian transliteration, verified undo and repeated conversion. - Text snippets across layouts, multiline insertion and a verified `{cursor}` position; - `{{cursor}}` inserts the literal marker. Snippets are stored as plaintext settings, as in Typlo. + `{{cursor}}` inserts the literal marker. Snippets are stored as plaintext settings, as in [Typlo](https://github.com/bitcodepro/Typlo). - Clipboard history for text, HTML/RTF, file lists, DIB and PNG images; plain-text paste; full-text search, pinning, deletion, full text viewing and image previews. - Image thumbnails and text/file icons appear directly in the history list. Only visible rows @@ -67,7 +67,7 @@ Ctrl+Alt+Delete and Win+L; these cannot be assigned. - Single instance and `--history`, `--convert`, `--case`, `--transliterate`, `--settings`, `--snippets`, `--exit` commands. `--convert` cycles layouts. -Default shortcuts match Typlo: Ctrl+Alt+Shift+Space (cycle), C (case), T (transliteration), +Default shortcuts match [Typlo](https://github.com/bitcodepro/Typlo): Ctrl+Alt+Shift+Space (cycle), C (case), T (transliteration), Z (undo), 1/2/3 (first layouts), and Ctrl+Shift+V (history). History controls: Enter to paste, Shift+Enter for plain text, Ctrl+1…9 for quick paste, @@ -81,19 +81,19 @@ the executable's directory is not writable. Each clipboard payload is an encrypt only bounded previews/metadata stay in memory. Image data is loaded on demand and released when the history popup is hidden. The log contains operational messages, never copied text or keystrokes. -Settings **Import** accepts a Typlo `settings.json`, preserving supported Windows layout IDs, -hotkeys, snippets, exclusions and limits. Import is staged until Save. Existing Typlo files are -never modified. Typlo's encrypted SQLite history is **not migrated** to the new DPAPI file format. +Settings **Import** accepts a [Typlo](https://github.com/bitcodepro/Typlo) `settings.json`, preserving supported Windows layout IDs, +hotkeys, snippets, exclusions and limits. Import is staged until Save. Existing [Typlo](https://github.com/bitcodepro/Typlo) files are +never modified. [Typlo](https://github.com/bitcodepro/Typlo)'s encrypted SQLite history is **not migrated** to the new DPAPI file format. DPAPI data belongs to the Windows account/machine; copying the portable folder is not a cross-account backup. ## Differences still to port This is a working native implementation, not a claim of complete UI/release parity: -- UI currently uses English and the native Windows control appearance. Typlo's ten-language UI and +- UI currently uses English and the native Windows control appearance. [Typlo](https://github.com/bitcodepro/Typlo)'s ten-language UI and explicit light/dark theme selector are not yet ported. - Automatic release download/replacement is not enabled. KSwitcher has no configured release feed; - using Typlo's feed would install the wrong application. Updates are manual. + using [Typlo](https://github.com/bitcodepro/Typlo)'s feed would install the wrong application. Updates are manual. - No import of old encrypted clipboard history. Export/import applies to settings. - The clipboard popup is fixed-size with per-monitor DPI scaling; PNG/DIB previews use Windows WIC/GDI. @@ -197,5 +197,5 @@ It still uses the normal instance lock; close a running KSwitcher first if measu - `ocr.*`: Windows WIC and OCR via the native Windows Runtime ABI. - `tests/`: regression checks, real editor integration and OCR fixture. -Application code is MIT licensed; preserves the original Typlo attribution in `LICENSE`. +Application code is MIT licensed; preserves the original [Typlo](https://github.com/bitcodepro/Typlo) attribution in `LICENSE`. Dictionary data has its own CC BY-SA 4.0 license as described above.