summaryrefslogtreecommitdiff
path: root/keyboards/nix_studio/oxalys80/readme.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2021-09-17 20:48:14 +0000
committerGitHub <noreply@github.com>2021-09-17 13:48:14 -0700
commit7c09b2667b49839d6c1a27133751d43642149a84 (patch)
tree8657df6e5811b41a66e8f80223c9978e9bbd14e2 /keyboards/nix_studio/oxalys80/readme.md
parent0c1341daa80b79ccbef8a9e7f895552ff57456e9 (diff)
Nix Studio OXALYS80 Refactor (#14473)
* update grid alignment of keycodes * update key assignments on via keymap A seemingly-misplaced key assignment on Layers 1 through 3 of the via keymap led to keys being off by one in comparison to the default keymap. * switch Backslash and Backspace on via keymap base layer Matches the via keymap's key mapping to that of the default keymap. * use QMK 3-character notation in oxalys80.h * add matrix diagram; remove Planck reference * add LAYOUT_tkl_ansi and LAYOUT_tkl_ansi_wkl layout macros * add LAYOUT_tkl_ansi_tsangan macro * add ISO layouts Add LAYOUT_tkl_iso, LAYOUT_tkl_iso_tsangan, and LAYOUT_tkl_iso_wkl macros. * enable Community Layouts support * tidy up rules.mk * readme tidy-up
Diffstat (limited to 'keyboards/nix_studio/oxalys80/readme.md')
-rw-r--r--keyboards/nix_studio/oxalys80/readme.md64
1 files changed, 35 insertions, 29 deletions
diff --git a/keyboards/nix_studio/oxalys80/readme.md b/keyboards/nix_studio/oxalys80/readme.md
index 44ad7e8286..a1b009ebe5 100644
--- a/keyboards/nix_studio/oxalys80/readme.md
+++ b/keyboards/nix_studio/oxalys80/readme.md
@@ -1,43 +1,49 @@
-oxalys80
-===
+# OXALYS80
-A QMK-powered replacement PCB for custom TKL keyboards. This PCB has the same size of the b.87 PCB, Hiney H87a, KBD8X.
+A QMK-powered replacement PCB for custom TKL keyboards. This PCB has the same size of the b.87 PCB, Hiney H87a, and KBD8X.
-Keyboard Maintainer: [Nix Studio](https://github.com/Nix-Studio)
-Hardware Supported: oxalys80 ver. 1.0
-Hardware Availability: [Nix Studio](https://www.instagram.com/nix.studio/)
+* Keyboard Maintainer: [Nix Studio](https://github.com/Nix-Studio)
+* Hardware Supported: oxalys80 ver. 1.0
+* Hardware Availability: [Nix Studio](https://www.instagram.com/nix.studio/)
Make example for this keyboard (after setting up your build environment):
-
- make nix_studio/oxalys80:default
-
+
+ make nix_studio/oxalys80:default
+
+Flashing example for this keyboard:
+
+ make nix_studio/oxalys80:default:flash
+
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).
-## oxalys80 hardware information
+## OXALYS80 Hardware Information
+
+Controller: ATmega32U4
+
+### Column Pin Configuration
+
+| col: | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 |
+|------|----|----|----|----|----|----|----|----|----|
+| pin: | F0 | F1 | F4 | F5 | F6 | F7 | C7 | B0 | B1 |
+
+### Row Pin Configuration
+
+| row: | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 |
+|------|----|----|----|----|----|----|----|----|----|----|----|----|
+| pin: | C6 | B6 | B5 | B4 | D7 | D6 | D4 | D5 | D3 | D2 | D1 | D0 |
-Controller: Atmega32u4
+The OXALYS80 PCB utilizes duplex matrix organization.
- /* Column pin configuration
- * col: 0 1 2 3 4 5 6 7 8
- * pin: F0 F1 F4 F5 F6 F7 C7 B0 B1
- */
-
- /* Row pin configuration
- * row: 0 1 2 3 4 5 6 7 8 9 10 11
- * pin: C6 B6 B5 B4 D7 D6 D4 D5 D3 D2 D1 D0
- */
-
-The oxalys PCB utilizes duplex matrix organization.
+### LED Pins
- Caps Lock LED: E6
- Scroll Lock LED: B2
- Num Lock LED: not supported
- Backlight Pin: B7
- RGB Data Pin: B3
-
+* Caps Lock LED: E6
+* Scroll Lock LED: B2
+* Num Lock LED: not supported
+* Backlight Pin: B7
+* RGB Data Pin: B3
+## In-switch Indicators
-In-switch indicators:
To connect the Caps Lock LED to the main backlight matrix, turn switch to top position on SW3. To use the Caps Lock LED as an indicator, turn switch to bottom position on SW3.
To connect the Scroll Lock LED to the main backlight matrix, turn switch to left position on SW2. To use the Scroll Lock LED as an indicator, turn switch to right position on SW2.