summaryrefslogtreecommitdiff
path: root/keyboards/handwired/10k/readme.md
diff options
context:
space:
mode:
authorNabos <9805355+nab-os@users.noreply.github.com>2022-04-13 08:03:49 +0200
committerGitHub <noreply@github.com>2022-04-12 23:03:49 -0700
commit3f66e25b41cdb9192f1a9efb2771fed36559afb0 (patch)
tree2355d52c6980b10b408b96639a42452ff2146d58 /keyboards/handwired/10k/readme.md
parente1c777a1c993efa6c739fde71f995ee386456237 (diff)
[Keyboard] add 10k (#16531)
Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Nicolas Ballet <balletn@igbmc.fr>
Diffstat (limited to 'keyboards/handwired/10k/readme.md')
-rw-r--r--keyboards/handwired/10k/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/handwired/10k/readme.md b/keyboards/handwired/10k/readme.md
new file mode 100644
index 0000000000..270297e927
--- /dev/null
+++ b/keyboards/handwired/10k/readme.md
@@ -0,0 +1,24 @@
+# 10k
+
+Simple 10 keys chord keyboard
+
+* Keyboard Maintainer: [Nabos](https://github.com/nab-os)
+* Hardware Supported: Tested with Elite-C V4 and ProMicro
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/10k:default
+
+Flashing example for this keyboard:
+
+ make handwired/10k: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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available