summaryrefslogtreecommitdiff
path: root/keyboards/chocv/readme.md
diff options
context:
space:
mode:
authorRichard <rich@brickbots.com>2022-07-17 09:35:09 -0700
committerGitHub <noreply@github.com>2022-07-17 09:35:09 -0700
commit747b33cb81ac2397419beac9653f9ce697a30b7b (patch)
treea7543d1a6345d313185332ee7d5ccd15ec43c824 /keyboards/chocv/readme.md
parent6025df79b3065c729d0807ad1abe655b896a38e2 (diff)
[Keyboard] Adding chocV keyboard (#15921)
* Adding chocV keyboard * Fix checklist issues / community layout support * Remove template cruft from readme * Fix image url in readme * Fix image url in readme to raw github content * Change readme example to use default Keymap * Remove vestigal config * More informative keymap readme * Config.h swapsies * Remove deprecated features * Conform / Modernize Rules * Conform / Modernize Rules * Clean up spacing * Update keyboards/chocv/readme.md Move build docs links to end :+1:
Diffstat (limited to 'keyboards/chocv/readme.md')
-rw-r--r--keyboards/chocv/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/chocv/readme.md b/keyboards/chocv/readme.md
new file mode 100644
index 0000000000..67bb9aad02
--- /dev/null
+++ b/keyboards/chocv/readme.md
@@ -0,0 +1,26 @@
+# chocV
+
+A 36 key choc keyboard based on the [Horizon](https://github.com/skarrmann/horizon)
+construction and a trimmed down [BabyV](https://www.instagram.com/eyeohdesigns/?hl=en) layout!
+
+![chocV Lineage](https://raw.githubusercontent.com/brickbots/chocV/main/images/lineage.jpeg "chocV Lineage")
+
+* Keyboard Maintainer: [Brickbots](https://github.com/brickbots)
+* Hardware Supported: The chocV PCB is public domain and is compatible with any
+pro-micro footprint MCU
+* Hardware Availability: [The chocV github repo](https://github.com/brickbots/chocV)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make chocv:default
+
+Flashing example for this keyboard:
+
+ make chocv:default:flash
+
+## Bootloader
+
+Enter the bootloader using the hardware reset button on the top middle of the
+near the MCU.
+
+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).