keychron_qmk_firmware/keyboards/program_yoink/readme.md
James Young 3a7573436a
Program Yoink! refactor (#11636)
* split config.h for each variant

* split rules.mk for each variant

* split source and header files for each variant

* move keymaps to the appropriate variant

* update keyboard readme

* update keymap readmes

* differentiate Staggered and Ortho USB Device Strings

* clean up formatting in info.json

* split info.json files for each variant

* break up the info.json for readability

* correct key positioning and board dimensions

* correct key object sequences

* add weak encoder function to keyboard level

Allows Configurator-compiled firmware to have encoder functionality.

* add variant-specific readme files and bootloader instructions
2021-01-22 18:02:40 -08:00

22 lines
1.1 KiB
Markdown

# Program Yoink!
![Program Yoink! Staggered](https://i.imgur.com/2bBLKJrl.jpeg)
Program Yoink is a 12u main cluster board accompanied by a macro column with optional encoder support and arrow keys.
* Keyboard Maintainer: [melonbred](https://github.com/melonbred)
* Hardware Supported: [Program Yoink! Staggered](staggered/) and [Ortho](ortho/) PCBs (ATmega32u2)
* Hardware Availability: [P3D Store](https://p3dstore.com/products/yoink-gb)
Make example for this keyboard (after setting up your build environment):
make program_yoink/staggered:default
make program_yoink/ortho:default
To reset the board into bootloader mode, do one of the following:
* Tap the Reset switch mounted on the bottom side of the PCB
* Hold the key at the top left of the keyboard while connecting the USB cable (also erases persistent settings)
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).