summaryrefslogtreecommitdiffstats
path: root/keyboards/lucid/alexa/readme.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2021-10-13 05:47:54 +0000
committerGitHub <noreply@github.com>2021-10-12 22:47:54 -0700
commitbc51e330c0c183e78e415b6cfbf475990eb1ba86 (patch)
treed287cd482104a3769259d4b70238a4e5114826a2 /keyboards/lucid/alexa/readme.md
parentc63c78f0801f595f2200dab7246a1264b1ec847d (diff)
Lucid Alexa layout macro rework (#14799)
* refactor keymaps for readability - use QMK-native keycode aliases - physically align keycodes * rework layout macro A discrepancy between the default and via keymaps prompted a deep dive into the keyboard's switch matrix, which led to the discovery that (1) the layout macro's arguments were not arranged physically, and (2) the keymaps didn't assign the keycodes to the same switches (the default keymap's keycodes were in the wrong sequence). Additionally, the layout macro was built to support a split Backspace, but named as if it were for a 2u Backspace, which broke the enabled support for Community Layout keymaps. This commit: - arranges the layout macro arguments according to physical order - corrects the keymaps - renames the layout macro to specify the split Backspace - disables Community Layout support - updates the `info.json` data * add LAYOUT_65_ansi_blocker * enable Community Layout support * update `info.json` metadata - use full product listing URL - use GitHub username for maintainer field * update readme - fix vendor link in lead paragraph - update metadata list - use GitHub username of keyboard maintainer - correct Supported Hardware - add Hardware Availability link - add flashing and bootloader instructions
Diffstat (limited to 'keyboards/lucid/alexa/readme.md')
-rw-r--r--keyboards/lucid/alexa/readme.md18
1 files changed, 15 insertions, 3 deletions
diff --git a/keyboards/lucid/alexa/readme.md b/keyboards/lucid/alexa/readme.md
index 70142271a1..a0cef72913 100644
--- a/keyboards/lucid/alexa/readme.md
+++ b/keyboards/lucid/alexa/readme.md
@@ -1,13 +1,25 @@
# Alexa Hotswap PCB by Maker Keyboards
-The following is the QMK Firmware for the Alexa Hotswap PCB for [MakerKeyboards](http://www.makerkeyboards.cm).
+The following is the QMK Firmware for the Alexa Hotswap PCB for [Maker Keyboards](https://www.makerkeyboards.com/).
---
-* Keyboard Maintainer: Maker Keyboards
-* Hardware Supported: Phantom
+* Keyboard Maintainer: [mrnoisytiger](https://github.com/mrnoisytiger)
+* Hardware Supported: Alexa Hotswap PCB (ATmega32U4)
+* Hardware Availability: [Maker Keyboards](https://www.makerkeyboards.com/products/alexa)
Make example for this keyboard (after setting up your build environment):
make lucid/alexa:default
+Flashing example for this keyboard:
+
+ make lucid/alexa:default:flash
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the top left key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available (Fn+Backslash by default)
+
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).