aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/5keys/readme.md
diff options
context:
space:
mode:
authormikiya4182025-03-20 22:54:54 +0100
committerGitHub2025-03-20 22:54:54 +0100
commit3a8c76fae59387df3435948a424cdd0fcda7d66f (patch)
tree15517916903a47237479a2522e475f6783c1ee1a /keyboards/5keys/readme.md
parent96882c6a67c95bd5d59873d0921f15a3903dd6dc (diff)
Develop 5keys (#24555)
* [Keyboard]Add 5keys * Add files via upload * Delete 5keys.json * Add files via upload * Delete 5keys_default.hex * Add keyboard 5keys * Add Copylight * Update keyboards/5keys/keyboard.json Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/5keys/keyboard.json Co-authored-by: Drashna Jaelre <drashna@live.com> * Update readme.md --------- Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/5keys/readme.md')
-rw-r--r--keyboards/5keys/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/5keys/readme.md b/keyboards/5keys/readme.md
new file mode 100644
index 0000000000..e14792d82b
--- /dev/null
+++ b/keyboards/5keys/readme.md
@@ -0,0 +1,27 @@
+# 5keys
+
+![5keys](https://imgur.com/yOkI4HT)
+
+This keyboard is a macro keyboard with five keys.
+
+* Keyboard Maintainer: [mikiya418](https://github.com/mikiya418)
+* Hardware Supported: 5keys PCBs, Pro Micro
+* Hardware Availability: [Thingiverse](https://www.thingiverse.com/thing:6834908)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make 5keys:default
+
+Flashing example for this keyboard:
+
+ make 5keys: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 `QK_BOOT` if it is available