summaryrefslogtreecommitdiffstats
path: root/keyboards/fjlabs/tf60ansi/readme.md
diff options
context:
space:
mode:
authorFelix Jen <fjen@felixjen.com>2021-09-15 19:25:30 -0700
committerGitHub <noreply@github.com>2021-09-15 19:25:30 -0700
commitae821ce4b77f873f5122747ee48c02778637bac6 (patch)
treedaf7032095d395976d08040195fdac1c80d0785f /keyboards/fjlabs/tf60ansi/readme.md
parent40c58b1734a074106610e4e0006054b4ccef4f9a (diff)
[Keyboard] Add FJLabs TF60 Variants and TF65 Variant (#14392)
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/fjlabs/tf60ansi/readme.md')
-rw-r--r--keyboards/fjlabs/tf60ansi/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/fjlabs/tf60ansi/readme.md b/keyboards/fjlabs/tf60ansi/readme.md
new file mode 100644
index 0000000000..29cbad3fca
--- /dev/null
+++ b/keyboards/fjlabs/tf60ansi/readme.md
@@ -0,0 +1,27 @@
+# FJLabs TF60 ANSI
+
+The following is the QMK Firmware for the FJLabs TF60 ANSI PCB, a universal tray mount 60% hotswap PCB with per key RGB LED's.
+
+The PCB will feature:
+* Kailh Hotswap sockets
+* QMK & VIA compatibility
+* Per-Key RGB LED's
+
+---
+
+* Keyboard Maintainer: FJLabs
+* Hardware Supported: TF60 ANSI
+
+Make example for this keyboard (after setting up your build environment):
+
+ make fjlabs/tf60ansi:default
+
+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 `RESET` if it is available \ No newline at end of file