summaryrefslogtreecommitdiffstats
path: root/keyboards/rgbkb/pan/readme.md
diff options
context:
space:
mode:
authorLegonut <legonut3@gmail.com>2020-11-10 01:22:22 -0500
committerGitHub <noreply@github.com>2020-11-09 22:22:22 -0800
commitabf1902ff597e77e910c0fb9a8d132b46f78317b (patch)
tree96e69eca6df482de55366d038e940484ad0d5ad5 /keyboards/rgbkb/pan/readme.md
parentaa90cf1da895aaa280cc19068037c74de644bd27 (diff)
[Keyboard] RGBKB Pan (#9587)
* Add new keyboard Pan Encoder switches still need work * New keyboard Pan Should be complete * Split MCU selection into 2 revision folders * [rgbkb/pan] Make requested changes for PR Additionally, set DEFAULT_FOLDER to rev1, and default rev1 to atmega32a (as all shipped kits include an atmega32a) * Apply suggestions from code review * Fix default keymap typo * add usb max power define * Commit suggested changes * Update keyboards/rgbkb/pan/config.h * Apply suggestions from code review Small copyright updates * Apply suggestions from code review
Diffstat (limited to 'keyboards/rgbkb/pan/readme.md')
-rw-r--r--keyboards/rgbkb/pan/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/rgbkb/pan/readme.md b/keyboards/rgbkb/pan/readme.md
new file mode 100644
index 0000000000..f7041605c6
--- /dev/null
+++ b/keyboards/rgbkb/pan/readme.md
@@ -0,0 +1,19 @@
+# Pan
+
+![pan](https://i.imgur.com/Q6pqCFFl.jpg)
+
+Ortho or Staggered DIY kit with RGB
+
+* Keyboard Maintainer: [RGBKB](https://github.com/RGBKB)
+* Hardware Supported: Pan, atmega32a or Proton-C
+* Hardware Availability: [rgbkb.net](https://www.rgbkb.net/), [GitHub](https://github.com/RGBKB/Keyboard-files/tree/master/Pan)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make rgbkb/pan/rev1/32a:default
+
+If you are using the Proton-C:
+
+ make rgbkb/pan/rev1/proton_c: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).