summaryrefslogtreecommitdiff
path: root/keyboards/a_dux/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/a_dux/readme.md')
-rw-r--r--keyboards/a_dux/readme.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/keyboards/a_dux/readme.md b/keyboards/a_dux/readme.md
new file mode 100644
index 0000000000..7d9956f1ef
--- /dev/null
+++ b/keyboards/a_dux/readme.md
@@ -0,0 +1,38 @@
+# Architeuthis Dux
+
+![Architeuthis Dux](https://raw.githubusercontent.com/tapioki/cephalopoda/main/Images/architeuthis_dux.png)
+
+AKA A. dux, A.D., "Giant squid"
+
+34 keys, same stagger as [D. gigas](https://github.com/tapioki/cephalopoda/tree/main/Dosidicus%20gigas), but with two thumb keys included. Pinky, ring, index, and inner columns splayed at 15, 5, 0, -5, -5 degrees. SplitKB Tenting Puck support. All PCB files are available on the [project's github page](https://github.com/tapioki/cephalopoda/tree/main/Architeuthis%20dux)
+
+Thank you [Perce](https://madebyperce.com/) for the logo.
+
+## Cases can be found here:
+
+* [Flat Case](https://github.com/madebyperce/aduxcase)
+* [Tented Case](https://github.com/jdart/adux-tent)
+* [Case with Plates](https://github.com/sadekbaroudi/cephalopoda/tree/main/Architeuthis%20dux/case)
+
+## Keyboard Info
+
+* Keyboard Maintainer: [tapioki](https://github.com/tapioki)
+* Hardware Supported: Architeuthis Dux
+* Hardware Availability: [GitHub](https://github.com/tapioki/cephalopoda/tree/main/Architeuthis%20dux)
+
+Make examples 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
+
+## 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
+* **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
+
+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).