aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/bm60rgb/readme.md
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2020-01-11 23:11:06 -0800
committerJames Young <18669334+noroadsleft@users.noreply.github.com>2020-01-11 23:11:06 -0800
commitb6917c782fab724c181576164a7512089e54e36e (patch)
tree19022b7b819b9e3ead1d472770292b3dfcd66bde /keyboards/bm60rgb/readme.md
parent08cd99683999eb8fa009116a80255c185fdb9a4b (diff)
downloadfirmware-b6917c782fab724c181576164a7512089e54e36e.tar.gz
firmware-b6917c782fab724c181576164a7512089e54e36e.tar.bz2
firmware-b6917c782fab724c181576164a7512089e54e36e.zip
[Keyboard] KPRepublic BM60 RGB (#7842)
* initial commit from script * edit all generated files with my name and some basic notes * implement RGB Matrix support * cleanups, file removals, and readme edits * Update keyboards/bm60hsrgb/config.h * rename to bm60rgb * update included library and info.json keyboard name * Update keyboards/bm60rgb/keymaps/default/readme.md
Diffstat (limited to 'keyboards/bm60rgb/readme.md')
-rw-r--r--keyboards/bm60rgb/readme.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/keyboards/bm60rgb/readme.md b/keyboards/bm60rgb/readme.md
new file mode 100644
index 000000000..dc093c7b4
--- /dev/null
+++ b/keyboards/bm60rgb/readme.md
@@ -0,0 +1,13 @@
+# BM60 RGB
+
+A 60% hotswap inswitch RGB keyboard from KP Republic.
+
+* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+* Hardware Supported: BM60 RGB
+* Hardware Availability: [KP Republic](https://kprepublic.com/products/bm60-rgb-60-gh60-hot-swappable-pcb-programmed-qmk-firmware-type-c)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make bm60rgb: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).