commit 55b2c5421958f735f23d35af64d72ddf35be96fb
parent 1189670232e2a1e06d1f479f52ad31fec55e6c06
Author: Lukas F. Hartmann <lukas@mntre.com>
Date: Fri, 20 Oct 2023 17:19:19 +0200
keyboard-fw: add us variants to readme
Diffstat:
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/reform2-keyboard-fw/README.md b/reform2-keyboard-fw/README.md
@@ -44,14 +44,18 @@ keyboard.hex. To build for the different layouts of the MNT Reform keyboards 2
or 3, define the `KBD_VARIANT_2` or `KBD_VARIANT_3` preprocessor variables,
respectively, using the `REFORM_KBD_OPTIONS` argument to `make`.
- make REFORM_KBD_OPTIONS=-DKBD_VARIANT_2 # default for keyboard 2.0
- make REFORM_KBD_OPTIONS=-DKBD_VARIANT_3 # keyboard 3.0 layout
+ make REFORM_KBD_OPTIONS=-DKBD_VARIANT_2_US # default for keyboard 2.0 (US)
+ make REFORM_KBD_OPTIONS=-DKBD_VARIANT_2 # default for keyboard 2.0 (non-US)
+ make REFORM_KBD_OPTIONS=-DKBD_VARIANT_3_US # keyboard 3.0 layout (US)
+ make REFORM_KBD_OPTIONS=-DKBD_VARIANT_3 # keyboard 3.0 layout (non-US)
Without any options, `KBD_VARIANT_2` is the default. To build for the
standalone keyboard for, define `KBD_MODE_STANDALONE` using
`REFORM_KBD_OPTIONS` like this:
+ make REFORM_KBD_OPTIONS="-DKBD_VARIANT_2_US -DKBD_MODE_STANDALONE"
make REFORM_KBD_OPTIONS="-DKBD_VARIANT_2 -DKBD_MODE_STANDALONE"
+ make REFORM_KBD_OPTIONS="-DKBD_VARIANT_3_US -DKBD_MODE_STANDALONE"
make REFORM_KBD_OPTIONS="-DKBD_VARIANT_3 -DKBD_MODE_STANDALONE"
To flash, put your keyboard into [flashing mode](https://mntre.com/reform2/handbook/parts.html#keyboard-firmware) and run: