summaryrefslogtreecommitdiffstats
path: root/keyboards/boardwalk/readme.md
diff options
context:
space:
mode:
authorzvecr <git@zvecr.com>2019-02-27 16:20:45 +0100
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-02-27 16:20:45 +0100
commita120a000d481ed14a87988383be46c5a76604bb6 (patch)
tree0788fa276b17ed416acaeb96db1784897873b559 /keyboards/boardwalk/readme.md
parenta0c36ed25318e863d5c47cf2b80423abd934c198 (diff)
downloadqmk_firmware-a120a000d481ed14a87988383be46c5a76604bb6.tar.gz
qmk_firmware-a120a000d481ed14a87988383be46c5a76604bb6.tar.xz
Add Configurator support and readme for boardwalk (#5261)
* Add configurator support and readme for boardwalk * Readme review comments
Diffstat (limited to 'keyboards/boardwalk/readme.md')
-rw-r--r--keyboards/boardwalk/readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/boardwalk/readme.md b/keyboards/boardwalk/readme.md
new file mode 100644
index 000000000..932e7e9d6
--- /dev/null
+++ b/keyboards/boardwalk/readme.md
@@ -0,0 +1,16 @@
+# 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 OLKB’s 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).