Skip to content

Commit e0601b8

Browse files
committed
docs(qmk): clean up and correct README documentation
- Update keyboard description to "Modified Piantor" - Correct layout specification from 42-key to 38-key split - Remove redundant documentation sections from piantor_tltr README - Simplify configuration overview
1 parent 6fb89db commit e0601b8

File tree

2 files changed

+3
-112
lines changed

2 files changed

+3
-112
lines changed

qmk/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ The QMK implementation provides hardware-level key remapping and advanced featur
88

99
## Target Keyboard
1010

11-
- **Keyboard**: [Piantor](https://github.com/beekeeb/piantor) by beekeeb
11+
- **Keyboard**: Modified [Piantor](https://github.com/beekeeb/piantor) by beekeeb
1212
- **Microcontroller**: RP2040 (Raspberry Pi Pico)
13-
- **Layout**: 38-key split keyboard (compatible with Cantor layout)
13+
- **Layout**: 38-key split keyboard
1414
- **Firmware directory**: `piantor_tltr/`
1515

1616
## Directory Structure

qmk/piantor_tltr/README.md

Lines changed: 1 addition & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This is a custom QMK keyboard configuration for the TLTR layout, based on the [P
77
- **Name**: Piantor TLTR
88
- **Microcontroller**: RP2040 (Raspberry Pi Pico)
99
- **Switches**: Cherry MX1A Red (linear)
10-
- **Layout**: 42-key split (6×3 + 3 thumb keys per side)
10+
- **Layout**: 38-key split (6×2 + 5x1 + 2 thumb keys per side)
1111
- **Communication**: Serial USART full-duplex between halves
1212
- **Bootloader**: RP2040 bootloader with double-tap reset
1313

@@ -24,82 +24,6 @@ This is a custom QMK keyboard configuration for the TLTR layout, based on the [P
2424
- **Double-tap reset**: Enabled
2525
- **Timeout**: 1000ms
2626

27-
## Keyboard Features
28-
29-
### Layers
30-
31-
1. **COLEMAK** (Base layer)
32-
- Colemak Mod-DH + Wide + Angle layout
33-
- Regular shift key (not one-shot)
34-
- Fork keys for context-sensitive behavior
35-
36-
2. **TL** (Left thumb layer)
37-
- Navigation keys (arrows, page up/down, tab)
38-
- Modifier keys (Alt, Ctrl, Shift, Meta)
39-
- One-shot modifier combinations (sWin, sHyp, sFn)
40-
41-
3. **TR** (Right thumb layer)
42-
- Numbers (0-9) with function key alternates (F1-F12)
43-
- Symbols and operators
44-
- Bracket pairs with shift-based switching
45-
46-
4. **TLTR** (Both thumbs layer)
47-
- Mouse movement and scrolling
48-
- Mouse buttons
49-
- Media controls (play/pause, volume, brightness)
50-
- Screen controls (lock, sleep)
51-
- System bootloader key
52-
53-
### Custom Features
54-
55-
#### Mouse Keys
56-
57-
- **Three speed modes**:
58-
- Default: 8 pixels per report (modestly fast)
59-
- Slow: 3 pixels per report
60-
- Precise: 1 pixel per report
61-
- **Natural scrolling**: Reversed scroll directions
62-
- **Constant speed**: No acceleration for predictable movement
63-
- **Scroll mode**: Convert mouse movement to scroll wheel
64-
65-
#### Fork Keys
66-
67-
Keys that change behavior based on modifiers:
68-
69-
- `KC_DELF`: Delete when shifted, Backspace normally
70-
- `KC_SLAF`: Backslash when shifted, Slash normally
71-
- `KC_COMF`: Underscore when shifted, Comma normally
72-
- `KC_DOTF`: Question when shifted, Period normally
73-
- `KC_PGUF`: Home when shifted, Page Up normally
74-
- `KC_PGDF`: End when shifted, Page Down normally
75-
- Symbol forks: !/`, @/~, #/^, $/₹, &/|, etc.
76-
77-
#### One-Shot Modifiers
78-
79-
- **Tap**: Activates modifier for next key only
80-
- **Hold**: Regular modifier behavior
81-
- **Timeout**: 200ms to distinguish tap from hold
82-
- **Custom combinations**:
83-
- `KC_OS_WIN`: Alt+Ctrl+Meta (window manager shortcuts)
84-
- `KC_OS_HYP`: Alt+Ctrl+Shift+Meta (hyper key)
85-
- `KC_OS_FN`: Function modifier for number→function key switching
86-
87-
#### OS Detection
88-
89-
Automatically detects the host OS on keyboard connection:
90-
91-
- **macOS/iOS**: Sets Unicode mode to macOS
92-
- **Windows**: Sets Unicode mode to WinCompose
93-
- **Linux**: Sets Unicode mode to Linux
94-
- **Unknown**: Defaults to Linux mode
95-
96-
#### Caps Word
97-
98-
- **Trigger**: Double-tap shift or `CW_TOGG` key
99-
- **Timeout**: 3000ms of inactivity
100-
- **Behavior**: Capitalizes letters, allows numbers and navigation
101-
- **Auto-release**: Deactivates on most punctuation keys
102-
10327
## Configuration Files
10428

10529
### config.h
@@ -148,36 +72,3 @@ All timing values match the Kanata implementation:
14872
- **One-shot timeout**: 300ms
14973
- **Caps Word timeout**: 3000ms
15074
- **Mouse interval**: 16ms (60Hz update rate)
151-
152-
## Custom Keycodes Reference
153-
154-
| Keycode | Tap | Hold/Shift |
155-
| ----------- | --------- | ---------------------- |
156-
| KC_DELF | Backspace | Delete |
157-
| KC_SLAF | / | \ |
158-
| KC_COMF | , | \_ |
159-
| KC_DOTF | . | ? |
160-
| KC_PGUF | Page Up | Home |
161-
| KC_PGDF | Page Down | End |
162-
| KC_EXCF | ! | ` |
163-
| KC_ATSF | @ | ~ |
164-
| KC_OCTF | # | ^ |
165-
| KC_DOLF | $ ||
166-
| KC_AMPF | & | \| |
167-
| KC_CURF | { | } |
168-
| KC_PARF | ( | ) |
169-
| KC_SQRF | [ | ] |
170-
| KC_1F-KC_0F | Number | Function key (with Fn) |
171-
| KC_ASTF | \* | F11 (with Fn) |
172-
| KC_PERF | % | F12 (with Fn) |
173-
174-
## Special Keys
175-
176-
| Key | Behavior |
177-
| -------------------- | --------------------------------- |
178-
| KC_MSLW | Mouse slow mode (hold) |
179-
| KC_MPRE | Mouse precise mode (hold) |
180-
| KC_MSCR | Mouse scroll mode (hold) |
181-
| KC_MUP/MDN/MLFT/MRGT | Mouse/scroll directions |
182-
| KC_SCRE | Tap: lock screen, Hold: sleep |
183-
| KC_MEDC | Tap: play/pause, Hold: next track |

0 commit comments

Comments
 (0)