locker98/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve handedness documentation for Architeuthis Dux (#15051)

Browse Source 
Co-authored-by: filterpaper <filterpaper@localhost>
This commit is contained in:
Albert Y 2021-11-06 00:00:34 +08:00 committed by GitHub
parent 25c93bd9a3
commit 74b3f76bf5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
keyboards/a_dux/readme.md
View File

@ -8,7 +8,7 @@ AKA A. dux, A.D., "Giant squid"
Thank you [Perce](https://madebyperce.com/) for the logo. Thank you [Perce](https://madebyperce.com/) for the logo.
## Cases can be found here: ## Case Options
* [Flat Case](https://github.com/madebyperce/aduxcase) * [Flat Case](https://github.com/madebyperce/aduxcase)
* [Tented Case](https://github.com/jdart/adux-tent) * [Tented Case](https://github.com/jdart/adux-tent)
@ -16,23 +16,30 @@ Thank you [Perce](https://madebyperce.com/) for the logo.
## Keyboard Info ## Keyboard Info
* Keyboard Maintainer: [tapioki](https://github.com/tapioki) * Keyboard Maintainer: [@tapioki](https://github.com/tapioki)
* Hardware Supported: Architeuthis Dux * 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
make a_dux:default:avrdude-split-left 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).
make a_dux:default:avrdude-split-right
## 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 ## Bootloader
Enter the bootloader in 3 ways: 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) * **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**: Briefly short the RST and GND pins on the microcontroller using tweezers, a paperclip, or any other conductive material. * **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 available * **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).