summaryrefslogtreecommitdiff
path: root/keyboards/ramlord/witf/readme.md
diff options
context:
space:
mode:
authorSleepdealer <35879391+Sleepdealr@users.noreply.github.com>2022-11-19 22:46:12 -0500
committerGitHub <noreply@github.com>2022-11-19 19:46:12 -0800
commite5e186c5169c8efde8350d01272ca01793eab96f (patch)
treed7c7862924502687536b7a1f7c9e7f8bb5d59901 /keyboards/ramlord/witf/readme.md
parent37c271460a537cb395c3bb9fbf84419b54aa00a8 (diff)
[Keyboard] Add WITF (#18922)
Co-authored-by: Joel Challis <git@zvecr.com>
Diffstat (limited to 'keyboards/ramlord/witf/readme.md')
-rw-r--r--keyboards/ramlord/witf/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/ramlord/witf/readme.md b/keyboards/ramlord/witf/readme.md
new file mode 100644
index 0000000000..a59b6f069f
--- /dev/null
+++ b/keyboards/ramlord/witf/readme.md
@@ -0,0 +1,23 @@
+# Ramlord WITF
+
+* Keyboard Maintainer: [Sleepdealer](https://github.com/Sleepdealr)
+* Hardware Supported: WITF PCB(s)
+* Hardware Availability: During GB
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ramlord/witf:default
+
+Flashing example for this keyboard:
+
+ make ramlord/witf: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 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 `QK_BOOT` if it is available