keychron_qmk_firmware/keyboards/boardwalk/readme.md
zvecr a120a000d4 Add Configurator support and readme for boardwalk (#5261)
* Add configurator support and readme for boardwalk

* Readme review comments
2019-02-27 07:20:45 -08:00

17 lines
989 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Boardwalk
![Boardwalk](https://i.imgur.com/CQj3b9E.jpg)
The Boardwalk is a 60% ortholinear keyboard, designed around Ergodox keycap sets and to fit into many standard 60% cases. The project was inspired by OLKBs Atomic keyboard, which used larger 2u mods, but u/shensmobile
decided to switch to 1.5u keys so that Ergodox sets would provide excellent compatibility. The rest of the board can be covered using standard key sizes from 60% sets.
Keyboard Maintainer: QMK Community
Hardware Supported: Boardwalk Ortholinear PCB
Hardware Availability: [panc.co](https://www.panc.co/boardwalk-group-buy.html)
Make example for this keyboard (after setting up your build environment):
make boardwalk:default
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).