summaryrefslogtreecommitdiffstats
path: root/keyboards/kb_elmo/vertex/readme.md
diff options
context:
space:
mode:
authorkb-elmo <lorwel@mailbox.org>2021-11-29 09:16:38 +0100
committerGitHub <noreply@github.com>2021-11-29 00:16:38 -0800
commitb90d94755c2c83da6ef6df80e0eb8d660cb718cc (patch)
tree8268d6fe24db092e4f6670ba9e1114c9ecbfe089 /keyboards/kb_elmo/vertex/readme.md
parent5b5b36421a7c887aad5bf5faef06dcf133d64f15 (diff)
[Keyboard] Add Vertex 40% (#15323)
Diffstat (limited to 'keyboards/kb_elmo/vertex/readme.md')
-rw-r--r--keyboards/kb_elmo/vertex/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/kb_elmo/vertex/readme.md b/keyboards/kb_elmo/vertex/readme.md
new file mode 100644
index 0000000000..0710e48070
--- /dev/null
+++ b/keyboards/kb_elmo/vertex/readme.md
@@ -0,0 +1,25 @@
+# Vertex
+
+![vertex](https://i.imgur.com/drRZO54l.jpg)
+
+3D printed Vortex 40% inspired screwless exterior, top-mount keyboard
+
+* Keyboard Maintainer: [kb-elmo](https://github.com/kb-elmo)
+* Hardware Supported: Vertex rev.1
+* Hardware Availability: [Open source project](https://github.com/kb-elmo/Vertex)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kb_elmo/vertex:default
+
+Flashing example for this keyboard:
+
+ make kb_elmo/vertex: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
+
+* **Bootmagic reset**: Hold down the top left key and plug in the keyboard
+* **Physical reset button**: Briefly press the button labeled "Reset" on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available