summaryrefslogtreecommitdiff
path: root/keyboards/ryanskidmore/rskeys100/readme.md
diff options
context:
space:
mode:
authorRyan Skidmore <github@ryanskidmore.co.uk>2022-05-02 20:34:44 +0100
committerGitHub <noreply@github.com>2022-05-02 12:34:44 -0700
commit66fc18c75646e77d9768803298777d39087577cf (patch)
tree4859f838fbcb6f002b68421873046325a73cb308 /keyboards/ryanskidmore/rskeys100/readme.md
parent8b668a24d65588d460488c811ef38bf23c44c283 (diff)
keyboards/ryanskidmore: add rskeys100 keyboard (#15506)
* keyboards/ryanskidmore/rskeys100: add rskeys100 draft firmware * keyboards/ryanskidmore/rskeys100: fix firmware * ryanskidmore/rskeys100: fix remaining bugs * keyboards/ryanskidmore/rskeys100: finishing touches on firmware * keyboards/ryanskidmore/rskeys100: migrate from full replacement matrix scanning to lite, move rgb matrix enable call to keymap * keyboards/ryanskidmore/rskeys100: remove undefines, clarify comments * ryanskidmore/rskeys100: remove unused imports * keyboards/ryanskidmore/rskeys100: pr feedback
Diffstat (limited to 'keyboards/ryanskidmore/rskeys100/readme.md')
-rw-r--r--keyboards/ryanskidmore/rskeys100/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/ryanskidmore/rskeys100/readme.md b/keyboards/ryanskidmore/rskeys100/readme.md
new file mode 100644
index 0000000000..4be465dbde
--- /dev/null
+++ b/keyboards/ryanskidmore/rskeys100/readme.md
@@ -0,0 +1,22 @@
+# rskeys100
+
+The rskeys100 is a full size, 100% ISO keyboard with per-key RGB.
+
+* Keyboard Maintainer: [Ryan Skidmore](https://github.com/ryanskidmore)
+* Hardware Supported: The rskeys100 matrix PCB is the only supported PCB for the switch matrix. This PCB works with any
+Pro Micro or Pro Micro alternative as the daughterboard.
+* Hardware Availability: Coming soon
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ryanskidmore/rskeys100:default
+
+Flashing example for this keyboard:
+
+ make ryanskidmore/rskeys100: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
+
+To enter the bootloader, press the `RESET` button on your daughterboard PCB while it's plugged in. \ No newline at end of file