summaryrefslogtreecommitdiff
path: root/keyboards/gorthage_truck/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/gorthage_truck/readme.md')
-rw-r--r--keyboards/gorthage_truck/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/gorthage_truck/readme.md b/keyboards/gorthage_truck/readme.md
new file mode 100644
index 0000000000..047aa0434a
--- /dev/null
+++ b/keyboards/gorthage_truck/readme.md
@@ -0,0 +1,19 @@
+# gorthage_truck
+
+This PCB is a drop-in ortholinear replacement for the Garbage Truck keyboard case. It supports 2x3u split bars, 7u, or 10u.
+
+* Keyboard Maintainer: [s8erdude](https://github.com/jpuerto96)
+* Hardware Supported: Gorthage Truck PCB
+* Hardware Availability: [Open Source PCB](https://github.com/jpuerto96/gorthage_truck)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make gorthage_truck:default
+
+Flashing example for this keyboard:
+
+ make gorthage_truck: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).
+
+To reset the board, you will want to short the pad labeled RESET1 on the back (near the MCU).