summaryrefslogtreecommitdiff
path: root/keyboards/handwired/chiron/readme.md
diff options
context:
space:
mode:
authorMichael B. Hix <m@hix.io>2019-10-25 15:48:57 -0700
committerDrashna Jaelre <drashna@live.com>2019-10-25 15:48:57 -0700
commitad5ead24c38a5ffe06017bd3f83b67ac65f75714 (patch)
tree2b612373d80af2e465f328fb8325892a67a28e1a /keyboards/handwired/chiron/readme.md
parentb2a63293763d14c7d9192367fa1890885227766e (diff)
[Keyboard] musl/add-chiron-keyboard (#7146)
* Add the Chiron keyboard * Add link to case repo * Update keyboards/handwired/chiron/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/handwired/chiron/keymaps/default/config.h Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/handwired/chiron/rules.mk Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/handwired/chiron/rules.mk Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/handwired/chiron/rules.mk Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/handwired/chiron/readme.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/handwired/chiron/rules.mk Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/handwired/chiron/rules.mk Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Clean up rules.mk for the configurator
Diffstat (limited to 'keyboards/handwired/chiron/readme.md')
-rw-r--r--keyboards/handwired/chiron/readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/handwired/chiron/readme.md b/keyboards/handwired/chiron/readme.md
new file mode 100644
index 0000000000..1e4bcf8b66
--- /dev/null
+++ b/keyboards/handwired/chiron/readme.md
@@ -0,0 +1,16 @@
+# Chiron Keyboard
+
+![chiron](https://i.imgur.com/3XZACfs.jpg)
+
+This is a custom keyboard meant to be easily and quickly 3D printable on
+most FFF/FDM printers. It's inspired by the [Viterbi](https://keeb.io/products/viterbi-keyboard-pcbs-5x7-70-split-ortholinear), [Iris](https://keeb.io/products/iris-keyboard-split-ergonomic-keyboard), and
+[Dactyl Manuform](https://github.com/adereth/dactyl-keyboard) keyboards.
+
+Keyboard Maintainer: [Mike Hix](https://github.com/musl/)
+Case: [https://github.com/musl/chiron-keyboard](https://github.com/musl/chiron-keyboard)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/chiron:default
+
+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).