summaryrefslogtreecommitdiff
path: root/keyboards/rotor/readme.md
diff options
context:
space:
mode:
authorNick Abe <57225836+2Moons-JP@users.noreply.github.com>2021-09-25 00:56:37 +0900
committerGitHub <noreply@github.com>2021-09-24 08:56:37 -0700
commit2d079c984f9dbf73124d1a07f530d2b2dca44932 (patch)
treed6b43e7458d07aa7aa439cd4b729808720b15cc2 /keyboards/rotor/readme.md
parent4f37084677d7868362809bdd7df44d44efab2b67 (diff)
[Keyboard] Add Rotor Keyboard (#14407)
* rotor keyboard * readme image * info.json update * Update readme.md * Update keyboards/rotor/rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/rotor/info.json Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/rotor/readme.md')
-rw-r--r--keyboards/rotor/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/rotor/readme.md b/keyboards/rotor/readme.md
new file mode 100644
index 0000000000..2fe7f5e494
--- /dev/null
+++ b/keyboards/rotor/readme.md
@@ -0,0 +1,19 @@
+# Rotor
+
+![Rotor](https://i.imgur.com/NfWdlzF.png)
+
+A 75 percent keyboard
+
+* Keyboard Maintainer: [2moons](https://github.com/2moons-jp)
+* Hardware Supported: Rotor PCB, ATMEGA32U4-MU
+* Hardware Availability: [Website](https://klc-playground.com/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make rotor:default
+
+To flash firmware onto this board, you'll need to bring the PCB into bootloader mode. To enter bootloader mode, press the reset button on the back of the PCB once. The reset button is located near the left side of the board near the TAB key.
+
+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)
+
+[Build guide](https://docs.google.com/document/d/1BWUkFYRJ3aB-AY9pEW-9av5j8VWKI2Hmt8xsCFQgDg0/edit)