summaryrefslogtreecommitdiff
path: root/keyboards/plx/readme.md
diff options
context:
space:
mode:
authorNick Abe <57225836+2Moons-JP@users.noreply.github.com>2021-06-20 11:14:40 +0900
committerGitHub <noreply@github.com>2021-06-19 19:14:40 -0700
commitc835d2e71dbc871483fdd62a31fc49a12e326170 (patch)
treeeb6d7dacc5b06ec229bb25b92b10446d80ab4f0f /keyboards/plx/readme.md
parent7e832e46de26989b81f2fbf58a0f391b2b0c1aaf (diff)
[Keyboard] Add PLX Keyboard (#12954)
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/plx/readme.md')
-rw-r--r--keyboards/plx/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/plx/readme.md b/keyboards/plx/readme.md
new file mode 100644
index 0000000000..b64abf7fb9
--- /dev/null
+++ b/keyboards/plx/readme.md
@@ -0,0 +1,19 @@
+# PLX
+
+![PLX](https://i.imgur.com/xJvv1kqh.jpg)
+
+An 60% gasket mounted board with a Tsangan layout and a 7 degree typing angle.
+
+* Keyboard Maintainer: [2Moons](https://github.com/2Moons-JP)
+* Hardware Supported: PLX PCB, ATMEGA32U4-AU
+* Hardware Availability: [Website](https://peac.design)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make plx:default
+
+To flash firmware onto this board, you'll need to bring the PCB into bootloader mode. To enter bootloader mode, press the reset button on the back of the PCB once. The reset button is located in the bottom near the space bar.
+
+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)
+
+[Build guide](https://peac.design/build-guide)