Skip to content

Commit 42ae6ce

Browse files
committed
UPdate Readme
1 parent fd5d21b commit 42ae6ce

File tree

1 file changed

+30
-137
lines changed

1 file changed

+30
-137
lines changed

README.md

Lines changed: 30 additions & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -2,182 +2,75 @@
22

33
# RightLayout
44

5-
### AI-powered keyboard layout corrector for macOS
5+
**Type freely.**
66

7-
![RightLayout Banner](assets/banner.png)
7+
RightLayout fixes your keyboard mistakes before you notice them.
88

9-
<details>
10-
<summary>See how it works</summary>
9+
[Download](https://github.com/chernistry/RightLayout/releases/latest) · [Website](https://hireex.ai/rightlayout)
1110

12-
![How it works](assets/howitworks.gif)
13-
14-
</details>
15-
16-
**[Website](https://hireex.ai/rightlayout)** · **[Source Code](https://github.com/chernistry/rightlayout-src)**
11+
---
1712

18-
[![macOS](https://img.shields.io/badge/macOS-13.0+-000?style=flat-square&logo=apple&logoColor=white)](https://www.apple.com/macos/)
19-
[![Download](https://img.shields.io/badge/Download-Latest_Release-6366f1?style=flat-square)](https://github.com/chernistry/rightlayout/releases/latest)
20-
[![Source](https://img.shields.io/badge/Source-Available-orange?style=flat-square)](https://github.com/chernistry/rightlayout-src)
13+
*English · Russian · Hebrew*
2114

22-
🇺🇸 English · 🇷🇺 Russian · 🇮🇱 **Hebrew**
15+
*macOS 13+ · Free*
2316

2417
</div>
2518

2619
---
2720

28-
## The Problem
21+
## How it works
2922

30-
You're typing, deep in thought... then you look up:
23+
You type in the wrong layout → RightLayout corrects it instantly.
3124

3225
```
33-
Ghbdtn, rfr ltkf? Привет, как дела?
34-
руддщ цщкдв hello world
35-
akuo שלום
26+
ghbdtn привет
27+
руддщ → hello
28+
akuo שלום
3629
```
3730

38-
Wrong keyboard layout. Again.
39-
40-
**RightLayout fixes this automatically, as you type.**
31+
No hotkeys. No notifications. Just correct text.
4132

4233
---
4334

44-
## ✨ Key Features
45-
46-
<table>
47-
<tr>
48-
<td width="50%">
49-
50-
**🚀 Type without thinking**
51-
52-
Just type. RightLayout detects wrong layouts on word boundaries and fixes them instantly. No hotkeys needed.
53-
54-
</td>
55-
<td width="50%">
56-
57-
**🧠 Self-learning**
58-
59-
Learns from your corrections. Undo a word twice — RightLayout remembers. Use Alt to pick an alternative — RightLayout learns your preference.
60-
61-
</td>
62-
</tr>
63-
<tr>
64-
<td>
65-
66-
**🔒 100% on-device**
35+
## Features
6736

68-
Everything runs locally. No network calls. No logging. No telemetry. Your keystrokes never leave your Mac.
37+
**Works invisibly**
38+
No popups, no interruptions. Corrections happen as you type.
6939

70-
</td>
71-
<td>
40+
**Learns you**
41+
Undo a correction twice — RightLayout remembers. It adapts to your writing style.
7242

73-
**⚡ Blazing fast**
74-
75-
Native CoreML model with CNN+Transformer ensemble trained on Wikipedia and OpenSubtitles dumps. Detection latency <50ms.
76-
77-
</td>
78-
</tr>
79-
<tr>
80-
<td>
81-
82-
**🇮🇱 Hebrew support**
83-
84-
One of the few correctors that properly handles Hebrew — including QWERTY-based layouts with sofit letters (ץ ך ם ן ף).
85-
86-
</td>
87-
<td>
88-
89-
**🔄 Hotkey cycling**
90-
91-
Press `Option` to cycle through alternatives: original → Russian → English → Hebrew → back.
92-
93-
</td>
94-
</tr>
95-
</table>
43+
**Stays private**
44+
Everything runs on your Mac. Nothing leaves your device. Ever.
9645

9746
---
9847

99-
## Installation
100-
101-
### 1. Download
102-
103-
Get the latest `.pkg` installer from [Releases](https://github.com/chernistry/rightlayout/releases/latest).
104-
105-
### 2. Install
48+
## Install
10649

107-
Double-click the PKG file and follow the installer prompts.
108-
109-
### 3. Grant Accessibility Access
110-
111-
On first launch, macOS will ask for Accessibility permission:
112-
113-
1. Open **System Settings → Privacy & Security → Accessibility**
114-
2. Enable **RightLayout**
115-
3. RightLayout will automatically start working once permission is granted
116-
117-
> **Note:** Accessibility access is required to monitor keyboard input. RightLayout cannot function without it.
118-
119-
---
120-
121-
## Usage
122-
123-
| Action | How |
124-
|--------|-----|
125-
| Toggle auto-correction | Click menu bar icon |
126-
| Cycle through alternatives | Press `Option` |
127-
| Undo last correction | Press `Option` immediately after |
128-
| Exclude an app | Settings → Per-App Rules |
129-
| Manage learned words | Settings → Dictionary |
130-
131-
---
132-
133-
## Troubleshooting
134-
135-
### "App is damaged" error
136-
137-
If macOS says the app is damaged, run in Terminal:
138-
```bash
139-
xattr -cr /Applications/RightLayout.app
140-
```
141-
142-
### Corrections not working
143-
144-
1. Check Accessibility permission is enabled
145-
2. Quit and reopen RightLayout
146-
3. Check if the app is in your exclusion list
147-
148-
### Wrong corrections
149-
150-
Press `Option` to cycle through alternatives, or disable auto-correction for that app.
50+
1. Download the `.pkg` from [Releases](https://github.com/chernistry/RightLayout/releases/latest)
51+
2. Run the installer
52+
3. Grant Accessibility permission when prompted
53+
4. Done — RightLayout works in the background
15154

15255
---
15356

154-
## Known Limitations
155-
156-
- **Single-letter prepositions:** `у` and `к` may not convert at phrase start (fix in progress)
157-
- **Punctuation inside words:** Words like `k.,k.` (люблю) may not convert correctly
158-
- **Sublime Text:** Alt cycling may insert text instead of replacing (app-specific behavior)
159-
- **Some terminal emulators:** May require clipboard fallback mode
160-
- **System autocorrection:** Disable "Correct spelling automatically" in System Settings → Keyboard for best results
57+
## Permissions
16158

162-
---
59+
RightLayout needs **Accessibility** access to detect and correct your typing. It cannot read passwords or secure fields.
16360

164-
## Requirements
165-
166-
- macOS Ventura (13.0) or later
167-
- Apple Silicon or Intel Mac
61+
All processing happens locally on your Mac.
16862

16963
---
17064

17165
## Feedback
17266

173-
Found a bug or have a feature idea? [Open an issue](https://github.com/chernistry/rightlayout/issues/new/choose).
67+
Found a bug? Have a suggestion?
68+
[Open an issue](https://github.com/chernistry/RightLayout/issues)
17469

17570
---
17671

17772
<div align="center">
17873

179-
[Download](https://github.com/chernistry/rightlayout/releases/latest) · [Source Code](https://github.com/chernistry/rightlayout-src) · [Report Issue](https://github.com/chernistry/rightlayout/issues)
180-
181-
Made by [Alex Chernysh](https://hireex.ai)
74+
Made with care by [Alex Chernysh](https://hireex.ai)
18275

18376
</div>

0 commit comments

Comments
 (0)