summaryrefslogtreecommitdiffstats
path: root/keyboards/bm40hsrgb/readme.md
diff options
context:
space:
mode:
authortominabox1 <tom.campie@gmail.com>2020-07-29 22:25:20 -0500
committerGitHub <noreply@github.com>2020-07-29 20:25:20 -0700
commit4f7cd5699e686053620127fefc3b30e237d4aa40 (patch)
tree6a6b466050200c2d4c51e53eb901fc79447ab997 /keyboards/bm40hsrgb/readme.md
parentbf05f773bd53f7bed9ae19eba691b7e7546eef71 (diff)
[Keyboard] Add KPRepublic BM40HSRGB keyboard (#9860)
* Initial Commit * Add readme.md's * Add license statements, cleaned up config, readme, and rules. Removed unused features from keymap and added ascii for Adjust layer * Update keyboards/bm40hsrgb/info.json * Update keyboards/bm40hsrgb/config.h
Diffstat (limited to 'keyboards/bm40hsrgb/readme.md')
-rw-r--r--keyboards/bm40hsrgb/readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/bm40hsrgb/readme.md b/keyboards/bm40hsrgb/readme.md
new file mode 100644
index 0000000000..766c8e4e8a
--- /dev/null
+++ b/keyboards/bm40hsrgb/readme.md
@@ -0,0 +1,20 @@
+# bm40hsrgb
+
+A 40% mechanical keyboard.
+
+This firmware was originally taken from a kbfirmware.json and manually converted. You may find the original `.json` files [here](https://drive.google.com/drive/folders/1tlTHQIFcluK2mjZ4UbbKCsdRLgSRSPw6).
+
+
+* Keyboard Maintainer: [tominabox1](https://github.com/tominabox1)
+* Hardware Supported: bm40hsrgb PCB
+* Hardware Availability: [KPRepublic](https://www.aliexpress.com/item/4001147779116.html)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make bm40hsrgb:default
+
+Flashing example for this keyboard:
+
+ make bm40hsrgb:default:flash
+
+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).