diff options
Diffstat (limited to 'keyboards/junco/readme.md')
| -rw-r--r-- | keyboards/junco/readme.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/keyboards/junco/readme.md b/keyboards/junco/readme.md new file mode 100644 index 0000000000..b5817ff7e7 --- /dev/null +++ b/keyboards/junco/readme.md @@ -0,0 +1,41 @@ +# Junco <!-- omit from toc --> + + + +Junco is a 60% Raspberry Pi Pico powered split keyboard boasting a 4x6 layout with an aggressive columnar stagger. It has 5 "thumb" keys on either side, support for 2-4 rotary encoders, and per-key RGB lighting. + +- Keyboard Maintainer: [Dane Skalski](https://github.com/Daneski13) +- Hardware Supported: Junco PCB, Raspberry Pi Pico +- Hardware Availability: [PCB, Case, Parts List](https://github.com/Daneski13/Junco) + +Remember you have to flash both halves of the keyboard for it to work! + +Make example for this keyboard (after setting up your build environment): + + make junco:default + +Flashing example for this keyboard: + +```bash +# For flashing the left half... +make junco:default:uf2-split-left +# or the qmk cli equivalent: +qmk flash -kb junco --keymap default -bl uf2-split-left + +# For flashing the right half... +make junco:default:uf2-split-right +# or the qmk cli equivalent: +qmk flash -kb junco --keymap default -bl uf2-split-right +``` + +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). + +## Bootloader <!-- omit from toc --> + +Enter the bootloader in 3 ways: + +- **Bootmagic reset** (works after you have flashed once): Hold down the top far corner key while plugging in the keyboard (`~` left half, `-` right half). This will also clear the EEPROM. +- **Physical reset button**: Hold the `BOOT` button on the Pico and press the `RST` button on the Pico, release the the `RST` button before the `BOOT` button. +- **Keycode in layout**: In the default layout, the `Bootloader` keycode is above home row pinky on the right side's adjust layer. + +Once you enter the bootloader, the keyboard will show up as a USB device on your computer, you could drag and drop a firmware file to flash it, but I recommend using the flash commands for the respective side. |