summaryrefslogtreecommitdiff
path: root/keyboards/kb58/readme.md
diff options
context:
space:
mode:
authorBeanaccle <25994266+Beanaccle@users.noreply.github.com>2022-03-08 12:40:46 +0900
committerGitHub <noreply@github.com>2022-03-07 19:40:46 -0800
commit86966fce69369fe4f82efcab9540805b26632967 (patch)
tree41c69847239054ccc1a97bd8af14304957407a99 /keyboards/kb58/readme.md
parentec3df85f08edf2636599edb96f358004ee020c86 (diff)
[Keyboard] Add KB58 (#15896)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/kb58/readme.md')
-rw-r--r--keyboards/kb58/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/kb58/readme.md b/keyboards/kb58/readme.md
new file mode 100644
index 0000000000..6d02b1787a
--- /dev/null
+++ b/keyboards/kb58/readme.md
@@ -0,0 +1,23 @@
+# KB58
+
+![kb58_pico](https://user-images.githubusercontent.com/25994266/146207912-b725e22f-92dc-4a40-9157-c2fddff45ce2.jpg)
+
+This is 58 keys keyboard.
+
+* Keyboard Maintainer: [beanaccle](https://github.com/beanaccle)
+* Hardware Supported: KB58
+* Hardware Availability: [KB58 Pico](https://github.com/beanaccle/kb58_pico)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kb58:default
+
+## 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
+
+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).