diff options
author | Albert Y <76888457+filterpaper@users.noreply.github.com> | 2021-11-06 00:00:34 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-11-05 09:00:34 -0700 |
commit | 74b3f76bf52a567b89c520adb3ecd58addd65d83 (patch) | |
tree | f6190e99c5600a7fc73a17e390d91a48f9a798f7 /keyboards/a_dux | |
parent | 25c93bd9a390a7b9bad61b98424afcfad5d236bf (diff) | |
download | qmk_firmware-74b3f76bf52a567b89c520adb3ecd58addd65d83.tar.gz qmk_firmware-74b3f76bf52a567b89c520adb3ecd58addd65d83.zip |
Improve handedness documentation for Architeuthis Dux (#15051)
Co-authored-by: filterpaper <filterpaper@localhost>
Diffstat (limited to 'keyboards/a_dux')
-rw-r--r-- | keyboards/a_dux/readme.md | 27 |
1 files changed, 17 insertions, 10 deletions
diff --git a/keyboards/a_dux/readme.md b/keyboards/a_dux/readme.md index aaf678ec7..ae06fa9fa 100644 --- a/keyboards/a_dux/readme.md +++ b/keyboards/a_dux/readme.md | |||
@@ -8,7 +8,7 @@ AKA A. dux, A.D., "Giant squid" | |||
8 | 8 | ||
9 | Thank you [Perce](https://madebyperce.com/) for the logo. | 9 | Thank you [Perce](https://madebyperce.com/) for the logo. |
10 | 10 | ||
11 | ## Cases can be found here: | 11 | ## Case Options |
12 | 12 | ||
13 | * [Flat Case](https://github.com/madebyperce/aduxcase) | 13 | * [Flat Case](https://github.com/madebyperce/aduxcase) |
14 | * [Tented Case](https://github.com/jdart/adux-tent) | 14 | * [Tented Case](https://github.com/jdart/adux-tent) |
@@ -16,23 +16,30 @@ Thank you [Perce](https://madebyperce.com/) for the logo. | |||
16 | 16 | ||
17 | ## Keyboard Info | 17 | ## Keyboard Info |
18 | 18 | ||
19 | * Keyboard Maintainer: [tapioki](https://github.com/tapioki) | 19 | * Keyboard Maintainer: [@tapioki](https://github.com/tapioki) |
20 | * Hardware Supported: Architeuthis Dux | 20 | * Hardware Supported: Architeuthis Dux |
21 | * Hardware Availability: [GitHub](https://github.com/tapioki/cephalopoda/tree/main/Architeuthis%20dux) | 21 | * Hardware Availability: Order PCBs with gerber files from the [repository](https://github.com/tapioki/cephalopoda/tree/main/Architeuthis%20dux) |
22 | 22 | ||
23 | Make examples for this keyboard (after setting up your build environment): | 23 | Make example for this keyboard (after setting up your build environment): |
24 | 24 | ||
25 | make a_dux:default | 25 | make a_dux:default |
26 | 26 | ||
27 | make a_dux:default:avrdude-split-left | 27 | 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). |
28 | make a_dux:default:avrdude-split-right | 28 | |
29 | ## Setting Handedness | ||
30 | |||
31 | Keyboard uses [handedness by EEPROM](https://docs.qmk.fm/#/feature_split_keyboard?id=handedness-by-eeprom) as default. The make commands are: | ||
32 | |||
33 | make a_dux:default:dfu-split-left | ||
34 | make a_dux:default:dfu-split-right | ||
35 | |||
36 | [QMK Toolbox](http://qmk.fm/toolbox) can also be used to set EEPROM handedness. Place the controller in bootloader mode and select menu option Tools -> EEPROM -> Set Left/Right Hand | ||
29 | 37 | ||
30 | ## Bootloader | 38 | ## Bootloader |
31 | 39 | ||
32 | Enter the bootloader in 3 ways: | 40 | Enter the bootloader in 3 ways: |
33 | 41 | ||
34 | * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard. (With `EE_HANDS` configured, hold down the top right key on the right half to place the right controller in bootloader mode) | 42 | * **Bootmagic reset**: Hold down the top left key on the left half (or the top right right key on the right half) and plug in the controller on that side. |
35 | * **Physical reset**: Briefly short the RST and GND pins on the microcontroller using tweezers, a paperclip, or any other conductive material. | 43 | * **Physical reset pins**: Briefly short the RST and GND pins on the microcontroller using tweezers, a paperclip, or any other conductive material. |
36 | * **Keycode in layout**: Press the key mapped to `RESET` if it is available | 44 | * **Keycode in layout**: Press the key mapped to `RESET` if it is configured. |
37 | 45 | ||
38 | 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). | ||