Conversation
- Add detailed project description for ZMK Corne keyboard configuration - Include feature overview with all 9 layers and their purposes - Add visual keyboard charts for each layer showing key mappings - Document home row mods, combos, and custom behaviors - Include installation instructions and configuration details - Add layer reference table and Bluetooth profile information
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for a ZMK Corne keyboard configuration project by creating a detailed README.md file. The documentation provides both high-level overview for newcomers and technical details for users wanting to understand or modify the keyboard configuration.
Key changes:
- Complete project documentation with hardware details, features overview, and configuration structure
- Visual ASCII art keyboard layouts for all 9 layers showing exact key mappings
- Detailed installation guide and customization instructions
| - **JK**: Enter (works on most layers) | ||
| - **DV**: Backslash | ||
| - **KH**: Forward slash | ||
| - **JKL**: Toggle between Empty and Games layers |
There was a problem hiding this comment.
This combo description conflicts with the keyboard layouts shown above. In the layouts, J, K, and L keys are positioned differently and some have modifiers (e.g., 'SHFT/J', 'CTRL/K'). The combo documentation should clarify whether this refers to the base keys or the modified versions.
| - **JKL**: Toggle between Empty and Games layers | |
| - **JKL**: Toggle between Empty and Games layers (uses base keys J, K, and L without modifiers) |
| ├─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤ ├─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤ | ||
| │ SHIFT │ ~ │ - │ _ │ { │ } │ │ [ │ ] │ < │ > │ : │ ; │ | ||
| ╰─────────┴─────────┴─────────┼─────────┼─────────┼─────────┤ ├─────────┼─────────┼─────────┼─────────┴─────────┴─────────╯ | ||
| │ │ │ MAINT │ │ SPACE │ ALT │ BKSP │ |
There was a problem hiding this comment.
The 'MAINT' key reference is inconsistent with the layer naming convention used elsewhere in the document. The layer is called 'Maintenance Layer' and 'MAINTENANCE' in the table, so this should be 'MAINTENANCE' for consistency.
| │ │ │ MAINT │ │ SPACE │ ALT │ BKSP │ | |
| │ │ │MAINTENANCE│ │ SPACE │ ALT │ BKSP │ |
| ├─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤ ├─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤ | ||
| │ CTRL │ │ LEFT │ DOWN │ RIGHT │ │ │ │ LEFT │ DOWN │ RIGHT │ │ CTRL │ | ||
| ├─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤ ├─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤ | ||
| │ QWERT │ │ │ │ │ │ │ │ │ │ │ │ QWERT │ |
There was a problem hiding this comment.
The 'QWERT' key references are inconsistent with the layer naming. The layer is called 'QWERTY Layer' elsewhere, so these keys should be labeled 'QWERTY' for consistency.
| │ QWERT │ │ │ │ │ │ │ │ │ │ │ │ QWERT │ | |
| │ QWERTY │ │ │ │ │ │ │ │ │ │ │ │ QWERTY │ |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Summary
This PR adds a comprehensive README.md file for the ZMK Corne keyboard configuration project.
Changes
Layer Charts Include
The README provides both high-level overview for newcomers and technical details for users wanting to understand or modify the configuration.
Benefits