qmk_firmware/keyboards/aleblazer/zodiark/readme.md
Aleblazer 86e28b4db8
Adding Zodiark Split keyboard (#11837)
* Adding Files for Zodiark

* zodiark.h and keymap.c layout corrections

* Apply suggestions from code review

Applied all suggestions from zvecr.

Co-authored-by: Joel Challis <git@zvecr.com>

* Applied all suggestions from fauxpark

Co-authored-by: Ryan <fauxpark@gmail.com>

* Defined matrix driver

* Update keymap with GPL2

* Added GPL2+ to All keymap.c, cleaned up config.h, and removed the rgbmatrixwip keymap

* Apply suggestions from code review

Removed the two lines from the config.h and changed to the smaller resolution picture on the Readme.

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>

* Added VIA keymap

* Corrected VIA Keymap oled.c

Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2021-03-06 18:56:48 +00:00

24 lines
1.2 KiB
Markdown

# Zodiark Keyboard
![Zodiark Split](https://i.imgur.com/49O8aowl.jpg)
A split keyboard with 5x7 including a thumbcluster, encoders on each side, per key RGB, and 2x I2C headers per side, supporiting 1.3"/.96" 128x64 OLEDs (the 1.3" is an SSH1106 OLED, refer to QMK documentation for limitations), .91" 128x32 OLEDs.
* Keyboard Maintainer: [Aleblazer](https://github.com/Aleblazer/), [Discord Link](https://discord.gg/BCSbXwskVt)
* Hardware Supported: Pro Micro and derivatives
* Hardware Availability: Pending Group Buy - [Discord Link](https://discord.gg/BCSbXwskVt)
Make example for this keyboard (after setting up your build environment):
make zodiark:default
Flashing example for this keyboard:
make zodiark:default:flash
Remove TRRS cable from halves, plug into one side, press reset button when asked. Repeat process on the other side.
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).
Credit to Sofle and Josef Adamcik <josef.adamcik@gmail.com> for OLED and layer code.