summaryrefslogtreecommitdiff
path: root/keyboards/chocv/keymaps/default/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/keymaps/default/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/keymaps/default/readme.md')
-rw-r--r--keyboards/chocv/keymaps/default/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/chocv/keymaps/default/readme.md b/keyboards/chocv/keymaps/default/readme.md
new file mode 100644
index 0000000000..0d9b3630ab
--- /dev/null
+++ b/keyboards/chocv/keymaps/default/readme.md
@@ -0,0 +1,24 @@
+# chocV Keymap
+
+The default keymap provided here is useful for testing and as a base
+for your own mapping, but does not include layers and is missing many
+keycodes. To build the default keymap for testing:
+
+make chocv:default
+
+## Give Miryoku a try
+
+If you are looking for a full fetured keymap, you can build the
+firmware with Miryoku without any additional work
+
+For details and building instructions and options please see the
+[The official Miryoku QMK
+Repo](https://github.com/manna-harbour/miryoku_qmk/tree/miryoku/users/manna-harbour_miryoku)
+
+The command to build with the default Miryoku layout is:
+
+make chocv:manna-habour_miryoku
+
+
+
+