sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a bit of important documentation

Browse Source
This commit is contained in:
Josh Klar 2018-10-18 23:59:26 -07:00
parent 9646c89d3a
commit 758e4de82b
No known key found for this signature in database
GPG Key ID: 220F99BD7DB7A99E
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/keymap.md
View File

@ -15,6 +15,14 @@ The basics of what you'll need to get started are:
- Assign a `Firmware` instance to a variable (ex. `keyboard = Firmware()` - note - Assign a `Firmware` instance to a variable (ex. `keyboard = Firmware()` - note
the parentheses) the parentheses)
- Make sure this `Firmware` instance is actually run at the end of the file with
a block such as the following:
```python
if __name__ == '__main__':
keyboard.go()
```
- Assign pins and your diode orientation (only necessary on handwire keyboards), - Assign pins and your diode orientation (only necessary on handwire keyboards),
for example: for example:
@ -25,9 +33,9 @@ rollover_cols_every_rows = 4
diode_orientation = DiodeOrientation.COLUMNS diode_orientation = DiodeOrientation.COLUMNS
swap_indicies = { swap_indicies = {
(3, 3): (3, 9), (3, 3): (3, 9),
(3, 4): (3, 10), (3, 4): (3, 10),
(3, 5): (3, 11), (3, 5): (3, 11),
} }
``` ```