summaryrefslogtreecommitdiff
path: root/keyboards/a_dux
diff options
context:
space:
mode:
authorAlbert Y <76888457+filterpaper@users.noreply.github.com>2021-11-06 00:00:34 +0800
committerGitHub <noreply@github.com>2021-11-05 09:00:34 -0700
commit74b3f76bf52a567b89c520adb3ecd58addd65d83 (patch)
treef6190e99c5600a7fc73a17e390d91a48f9a798f7 /keyboards/a_dux
parent25c93bd9a390a7b9bad61b98424afcfad5d236bf (diff)
downloadqmk_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.md27
1 files changed, 17 insertions, 10 deletions
diff --git a/keyboards/a_dux/readme.md b/keyboards/a_dux/readme.md
index aaf678ec74..ae06fa9faa 100644
--- a/keyboards/a_dux/readme.md
+++ b/keyboards/a_dux/readme.md
@@ -8,7 +8,7 @@ AKA A. dux, A.D., "Giant squid"
Thank you [Perce](https://madebyperce.com/) for the logo.
-## Cases can be found here:
+## Case Options
* [Flat Case](https://github.com/madebyperce/aduxcase)
* [Tented Case](https://github.com/jdart/adux-tent)
@@ -16,23 +16,30 @@ Thank you [Perce](https://madebyperce.com/) for the logo.
## Keyboard Info
-* Keyboard Maintainer: [tapioki](https://github.com/tapioki)
+* Keyboard Maintainer: [@tapioki](https://github.com/tapioki)
* Hardware Supported: Architeuthis Dux
-* Hardware Availability: [GitHub](https://github.com/tapioki/cephalopoda/tree/main/Architeuthis%20dux)
+* Hardware Availability: Order PCBs with gerber files from the [repository](https://github.com/tapioki/cephalopoda/tree/main/Architeuthis%20dux)
-Make examples for this keyboard (after setting up your build environment):
+Make example for this keyboard (after setting up your build environment):
make a_dux:default
- make a_dux:default:avrdude-split-left
- make a_dux:default:avrdude-split-right
+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).
+
+## Setting Handedness
+
+Keyboard uses [handedness by EEPROM](https://docs.qmk.fm/#/feature_split_keyboard?id=handedness-by-eeprom) as default. The make commands are:
+
+ make a_dux:default:dfu-split-left
+ make a_dux:default:dfu-split-right
+
+[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
## Bootloader
Enter the bootloader in 3 ways:
-* **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)
-* **Physical reset**: Briefly short the RST and GND pins on the microcontroller using tweezers, a paperclip, or any other conductive material.
-* **Keycode in layout**: Press the key mapped to `RESET` if it is available
+* **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.
+* **Physical reset pins**: Briefly short the RST and GND pins on the microcontroller using tweezers, a paperclip, or any other conductive material.
+* **Keycode in layout**: Press the key mapped to `RESET` if it is configured.
-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).