summaryrefslogtreecommitdiff
path: root/keyboards/crbn/readme.md
diff options
context:
space:
mode:
authorReFil <31960031+ReFil@users.noreply.github.com>2020-12-30 03:26:16 +0000
committerGitHub <noreply@github.com>2020-12-29 19:26:16 -0800
commitfda514bbd7bb26a8a6cc12cd1d5e36b0d12e7ae0 (patch)
tree2abc4645e5c6e6c5d37eb360418382f337f01860 /keyboards/crbn/readme.md
parentc9156b50d9fe448222144cc31ff5fe66e9a847c8 (diff)
[Keyboard] Polarity works CRBN support (#11107)
* Initial CRBN compatibility Updated readme.md too * formatting tweaks to meet requirements * Update crbn.c * Create readme.md * Required fixes and licence header * Fixes * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/crbn/rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update crbn.c * Update keyboards/crbn/crbn.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Licence headers * Create info.json * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * Configurator support * Update keymap.c * Update keymap.c Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/crbn/readme.md')
-rw-r--r--keyboards/crbn/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/crbn/readme.md b/keyboards/crbn/readme.md
new file mode 100644
index 0000000000..a8a1535c33
--- /dev/null
+++ b/keyboards/crbn/readme.md
@@ -0,0 +1,19 @@
+# CRBN
+
+A compact 40% (12x4) ortholinear keyboard kit made by Polarity Works and sold by keygem
+
+* Keyboard Maintainer: [ReFil](https://github.com/ReFil)
+* Hardware Supported: CRBN kit with a pro micro
+* Hardware Availability: [Keygem](https://keygem.store/collections/group-buys/products/group-buy-featherlight-40-kit)
+
+Support for this keyboard is available in the Polarity Works [discord](https://discord.gg/NysAH3Gser)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make crbn:default
+
+Flashing example for this keyboard:
+
+ make crbn: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).