aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/bm16s/readme.md
diff options
context:
space:
mode:
authorGravatar Benjamin <ben@bontakun.net>2019-04-30 19:29:51 -0700
committerGravatar Drashna Jaelre <drashna@live.com>2019-04-30 19:29:51 -0700
commit8725197ad679647d2eb7876aee3f9df32edb5766 (patch)
tree731c6841618d208c49bb8a87996dcc22af62bd39 /keyboards/bm16s/readme.md
parentd67b99ff3c2cfca63add546ad6d052e2487aa26a (diff)
downloadqmk_firmware-8725197ad679647d2eb7876aee3f9df32edb5766.tar.gz
[Keyboard] Adds support for BM16S keyboard (#5659)
* Added support for BM16S keyboard. * Update keyboards/bm16s/bm16s.h Co-Authored-By: bontakun <ben@bontakun.net> * Update keyboards/bm16s/bm16s.h Co-Authored-By: bontakun <ben@bontakun.net> * Cleaned up a bunch of unneeded stuff. * Made layout name match. * Changed rules file to have correct bootloader and indention. Updated readme to reflect availability on krepublic. Updated keymap to have more obvious RGB controls. * Removed unnecessary file. * Fixed grammar in readme. Co-Authored-By: bontakun <ben@bontakun.net> * Migrated to autogenerated layout config, without issue. * Renamed LAYOUT to match community standards.
Diffstat (limited to 'keyboards/bm16s/readme.md')
-rw-r--r--keyboards/bm16s/readme.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/keyboards/bm16s/readme.md b/keyboards/bm16s/readme.md
new file mode 100644
index 000000000..097a38008
--- /dev/null
+++ b/keyboards/bm16s/readme.md
@@ -0,0 +1,13 @@
+# bm16s
+
+A 16-key macropad, with USB C and per-key RGB backlighting. This is a variant of the BM16A, but with low profile Choc switches.
+
+Keyboard Maintainer: QMK Community
+Hardware Supported: The PCBs, controllers supported
+Hardware Availability: [KPrepublic](https://kprepublic.com/collections/pcb/products/bm16s-16-keys-custom-mechanical-keyboard-pcb-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-switch-leds-choc-switch); [AliExpress](https://www.aliexpress.com/item/bm16s-16-keys-Custom-Mechanical-Keyboard-PCB-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-switch/32999247908.html); [Massdrop](https://www.massdrop.com/buy/78169)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make bm16s: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).