summaryrefslogtreecommitdiffstats
path: root/keyboards/tgr/jane/v2/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/tgr/jane/v2/readme.md')
-rw-r--r--keyboards/tgr/jane/v2/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/tgr/jane/v2/readme.md b/keyboards/tgr/jane/v2/readme.md
new file mode 100644
index 0000000000..5c5a2d92d3
--- /dev/null
+++ b/keyboards/tgr/jane/v2/readme.md
@@ -0,0 +1,19 @@
+# Jane v2
+
+TKL Custom Keyboard.
+
+* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+* Hardware Supported: TGR Jane (Pontoporia) PCB v1.1, v1.2
+* Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=97552.1200)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make tgr/jane:default
+
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
+
+ make tgr/jane:default:flash
+
+**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Esc* while plugging in the keyboard.
+
+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).