summaryrefslogtreecommitdiffstats
path: root/keyboards/matrix/me/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-09-15 17:21:01 +0000
committerQMK Bot <hello@qmk.fm>2021-09-15 17:21:01 +0000
commita677f00502f765b13e25de4b749b5576dae9ecf0 (patch)
tree8e1914cf53fb6163ef197e5b7df2947592e39c7c /keyboards/matrix/me/readme.md
parent7d39c15cc423d35fbc89f462d645ed911f726b67 (diff)
parent303e063b71bba2b049f160a8bc50f33ac9538d8f (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/matrix/me/readme.md')
-rw-r--r--keyboards/matrix/me/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/matrix/me/readme.md b/keyboards/matrix/me/readme.md
new file mode 100644
index 0000000000..6a39bb0398
--- /dev/null
+++ b/keyboards/matrix/me/readme.md
@@ -0,0 +1,25 @@
+# Matrix ME
+
+A TKL keyboard with top gasket
+
+* Keyboard Maintainer: [astro](https://github.com/yulei)
+* Hardware Supported: Matrix ME keyboard
+* Hardware Availability: GB
+
+Make example for this keyboard (after setting up your build environment):
+
+ make matrix/me:default
+
+Flashing example for this keyboard:
+
+ make matrix/me: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 short cut the *RST* pin with the *GND* pin (pin at the topside of the *RST*) on the back of the PCB.
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available. \ No newline at end of file