From 758e4de82b0dc76a5d725c36074c94469bb0d979 Mon Sep 17 00:00:00 2001 From: Josh Klar Date: Thu, 18 Oct 2018 23:59:26 -0700 Subject: [PATCH] Add a bit of important documentation --- docs/keymap.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/keymap.md b/docs/keymap.md index 6d3e764..3914104 100644 --- a/docs/keymap.md +++ b/docs/keymap.md @@ -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 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), for example: @@ -25,9 +33,9 @@ rollover_cols_every_rows = 4 diode_orientation = DiodeOrientation.COLUMNS swap_indicies = { - (3, 3): (3, 9), - (3, 4): (3, 10), - (3, 5): (3, 11), + (3, 3): (3, 9), + (3, 4): (3, 10), + (3, 5): (3, 11), } ```