summaryrefslogtreecommitdiff
path: root/keyboards/chocofly/readme.md
diff options
context:
space:
mode:
authorWill Winder <wwinder.unh@gmail.com>2022-07-14 22:45:08 -0400
committerGitHub <noreply@github.com>2022-07-14 19:45:08 -0700
commit807620fa3c9995db29f0752162cee136a1381c13 (patch)
tree42fe5f334f288e87fe8813ca3db0decdd8b51d58 /keyboards/chocofly/readme.md
parentbe568177435c94a7c18217c5486e2df1062c3d73 (diff)
[Keyboard] Add Chocofly v1 (#17289)
* [Keyboard] Add Chocofly v1 * PR Feedback * Small change to keymap. * Replace KC__VOLUP and KC__VOLDOWN with single underscore version. * Apply suggestions from code review * Required for my PC * Required for my PC
Diffstat (limited to 'keyboards/chocofly/readme.md')
-rw-r--r--keyboards/chocofly/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/chocofly/readme.md b/keyboards/chocofly/readme.md
new file mode 100644
index 0000000000..0d9db2c04b
--- /dev/null
+++ b/keyboards/chocofly/readme.md
@@ -0,0 +1,23 @@
+# Chocofly
+
+![Chocofly v1.0](https://github.com/vlkv/chocofly/blob/master/images/chocofly_v1-0.jpg)
+
+An open source ergonomic monoblock 60% keyboard.
+
+* Keyboard Maintainer: [Vitaly Volkov](https://github.com/vlkv)
+* Hardware Supported: Chocofly PCB v1, Pro Micro 5V/16MHz and compatible.
+* Hardware Availability: [github.com/vlkv/chocofly](https://github.com/vlkv/chocofly)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make chocofly/v1:default
+
+Flashing example for this keyboard:
+
+ make chocofly/v1:default:flash
+
+## Bootloader
+
+Briefly press the button along the top edge of the PCB next to the microcontroller.
+
+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).