summaryrefslogtreecommitdiff
path: root/keyboards/program_yoink/staggered/readme.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2021-01-22 18:02:40 -0800
committerGitHub <noreply@github.com>2021-01-22 18:02:40 -0800
commit3a7573436ae6ab20973389a4051a8785399539f2 (patch)
tree4e9d11ac68e0744269495f7fae243eb46f120d54 /keyboards/program_yoink/staggered/readme.md
parent7e77c2361fbfba60fabb490a8dae310d5b7309ba (diff)
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/staggered/readme.md')
-rw-r--r--keyboards/program_yoink/staggered/readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/program_yoink/staggered/readme.md b/keyboards/program_yoink/staggered/readme.md
new file mode 100644
index 0000000000..1a1b7bb499
--- /dev/null
+++ b/keyboards/program_yoink/staggered/readme.md
@@ -0,0 +1,20 @@
+# Program Yoink! Staggered
+
+![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 PCB (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
+
+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).