diff options
| author | James Young <18669334+noroadsleft@users.noreply.github.com> | 2021-01-22 18:02:40 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-22 18:02:40 -0800 |
| commit | 3a7573436ae6ab20973389a4051a8785399539f2 (patch) | |
| tree | 4e9d11ac68e0744269495f7fae243eb46f120d54 /keyboards/program_yoink/readme.md | |
| parent | 7e77c2361fbfba60fabb490a8dae310d5b7309ba (diff) | |
| download | qmk_firmware-3a7573436ae6ab20973389a4051a8785399539f2.tar.gz qmk_firmware-3a7573436ae6ab20973389a4051a8785399539f2.zip | |
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
Diffstat (limited to 'keyboards/program_yoink/readme.md')
| -rw-r--r-- | keyboards/program_yoink/readme.md | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/keyboards/program_yoink/readme.md b/keyboards/program_yoink/readme.md index 6fa3bf4f7..4a1a867ec 100644 --- a/keyboards/program_yoink/readme.md +++ b/keyboards/program_yoink/readme.md | |||
| @@ -1,15 +1,21 @@ | |||
| 1 | # program_yoink | 1 | # Program Yoink! |
| 2 | 2 | ||
| 3 |  | 3 |  |
| 4 | 4 | ||
| 5 | Program Yoink is a 12u main cluster board accompanied by a macro column with optional encoder support and arrow keys. | 5 | Program Yoink is a 12u main cluster board accompanied by a macro column with optional encoder support and arrow keys. |
| 6 | 6 | ||
| 7 | * Keyboard Maintainer: [melonbred](https://github.com/yourusername) | 7 | * Keyboard Maintainer: [melonbred](https://github.com/melonbred) |
| 8 | * Hardware Supported: The PCBs, controllers supported | 8 | * Hardware Supported: [Program Yoink! Staggered](staggered/) and [Ortho](ortho/) PCBs (ATmega32u2) |
| 9 | * Hardware Availability: Links to where you can find this hardware | 9 | * Hardware Availability: [P3D Store](https://p3dstore.com/products/yoink-gb) |
| 10 | 10 | ||
| 11 | Make example for this keyboard (after setting up your build environment): | 11 | Make example for this keyboard (after setting up your build environment): |
| 12 | 12 | ||
| 13 | make program_yoink:default | 13 | make program_yoink/staggered:default |
| 14 | make program_yoink/ortho:default | ||
| 15 | |||
| 16 | To reset the board into bootloader mode, do one of the following: | ||
| 17 | |||
| 18 | * Tap the Reset switch mounted on the bottom side of the PCB | ||
| 19 | * Hold the key at the top left of the keyboard while connecting the USB cable (also erases persistent settings) | ||
| 14 | 20 | ||
| 15 | 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). | 21 | 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). |