summaryrefslogtreecommitdiffstats
path: root/keyboards/tg4x/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/tg4x/readme.md')
-rw-r--r--keyboards/tg4x/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/keyboards/tg4x/readme.md b/keyboards/tg4x/readme.md
new file mode 100644
index 0000000000..b1ce799512
--- /dev/null
+++ b/keyboards/tg4x/readme.md
@@ -0,0 +1,17 @@
+# TG4x v2.1
+
+40% sandwich keyboard driven by a pro micro.
+
+For more info please refer to [MythosMann's Github](www.github.com/MythosMann/tg4x).
+
+* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+* Hardware Supported: TG4x v2.1 PCB
+* Hardware Availability: [Geekhack](https://geekhack.org/index.php?topic=99163.0)
+
+If soldering in a RGB underglow strip, please use pin D2, the pin labeled RXI on the pro micro.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make tg4x: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).