From 23cfd36d8d2f036b1bf7d984b2a0fb04548411e2 Mon Sep 17 00:00:00 2001 From: Sebastian Legarraga <64795732+slegarraga@users.noreply.github.com> Date: Thu, 6 Aug 2026 08:29:38 -0400 Subject: [PATCH] docs: add Ukrainian quick-start README --- README.md | 2 +- README.uk.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 README.uk.md diff --git a/README.md b/README.md index aae4db7..7454cf2 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Lives in the system tray. Detects when you start typing in the wrong layout, switches it, and retypes the last word — like a friendly poltergeist that haunts your keyboard. -> 🌐 [Español](README.es.md) +> 🌐 [Español](README.es.md) · [Українська](README.uk.md) ![Typing "ma;ana" with the wrong layout active: PolterType switches the layout and retypes it as "mañana", and the rest of the sentence comes out right as typed](docs/screenshots/demo.gif) diff --git a/README.uk.md b/README.uk.md new file mode 100644 index 0000000..75e3211 --- /dev/null +++ b/README.uk.md @@ -0,0 +1,33 @@ +# PolterType + +Кросплатформовий автоматичний перемикач розкладки клавіатури. Працює в +системному треї, помічає, коли ви починаєте друкувати в неправильній розкладці, +перемикає її та повторює останнє слово — ніби доброзичливий полтергейст у вашій +клавіатурі. + +Повну документацію, нотатки для розробників і докладні застереження дивіться в +[англійському README](README.md). + +## Встановлення + +Бінарники публікуються на [сторінці Releases](../../releases). Кожен реліз +містить чотири інсталятори: + +| Система | Файл | Як встановити | +| --- | --- | --- | +| Windows 10 / 11 | `poltertype--x86_64-pc-windows-msvc.msi` | Подвійне натискання. Встановлення для користувача, без прав адміністратора та UAC. SmartScreen може показати «Windows захистив ваш ПК» → **Додатково** → **Виконати все одно**. | +| macOS 11+ (Intel та Apple Silicon) | `poltertype--universal-apple-darwin.dmg` | Відкрийте DMG і перетягніть `poltertype.app` у `/Applications`. Під час першого запуску клацніть правою кнопкою → **Відкрити** (або виконайте `xattr -dr com.apple.quarantine /Applications/poltertype.app`). Потім надайте **Спеціальні можливості** та **Моніторинг введення**, коли macOS попросить. | +| Linux (x86_64) | `poltertype--x86_64.AppImage` | `chmod +x` і запустіть. Встановлення для користувача, без системного встановлення. Дивіться [docs/PERMISSIONS.md](docs/PERMISSIONS.md) для доступу `evdev` у Wayland. | +| Linux (aarch64) | `poltertype--aarch64.AppImage` | Як вище, для ARM64: Raspberry Pi 5, Asahi, ноутбуки та сервери ARM. | + +> Інсталятори поки що **не підписані**, тому Gatekeeper або SmartScreen +> попереджають під час першого запуску. Підпис коду з’явиться на пізнішому етапі. + +> **Flatpak немає і не буде.** PolterType записує у `/dev/uinput`, на що жоден +> дозвіл Flatpak не дає права, окрім `--device=all` (усе дерево пристроїв), і для +> цього не існує порталу. Перемикання розкладки також потребує системних +> бінарників (`hyprctl`, `gsettings`, `qdbus`, `ibus`), яких у пісочниці немає. +> Використовуйте AppImage або нативний пакет. + +Збірку з вихідного коду описано в +[CONTRIBUTING.md](CONTRIBUTING.md).