summaryrefslogtreecommitdiff
path: root/keyboards/wsk/g4m3ralpha/readme.md
diff options
context:
space:
mode:
authorridingqwerty <george.g.koenig@gmail.com>2020-10-01 18:58:13 -0400
committerGitHub <noreply@github.com>2020-10-01 23:58:13 +0100
commit726499553c3ab0324274a66df63571a5a355d5df (patch)
treee5c80d36aafafb28e97b125c8841a9658a632b8a /keyboards/wsk/g4m3ralpha/readme.md
parent1d7e57ab853c3ee70ea287298b8e0f32ffe54072 (diff)
New keyboard: wsk/g4m3ralpha (#10431)
* adding alpha variants * adding cajal layouts * adding V2 PCB support adding additional layouts for new PCB version, and correecting incorrect image in info file * Cleanup master -- remove alpha9 * Cleanup master -- remove g4m3ralpha * Cleanup master -- remove cajal & sl40 * Master cleanup -- re-add sl40 * Master cleanup -- correct SL40 image * Add new keyboard: wsk/g4m3ralpha * Added license attribution to .{c,h} files * Update keyboards/wsk/g4m3ralpha/config.h Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/wsk/g4m3ralpha/rules.mk Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/wsk/g4m3ralpha/g4m3ralpha.c Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/wsk/g4m3ralpha/keymaps/default/keymap.c Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/wsk/g4m3ralpha/config.h Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/wsk/g4m3ralpha/info.json Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/wsk/g4m3ralpha/rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: worldspawn00 <mcmancuso@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/wsk/g4m3ralpha/readme.md')
-rw-r--r--keyboards/wsk/g4m3ralpha/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/wsk/g4m3ralpha/readme.md b/keyboards/wsk/g4m3ralpha/readme.md
new file mode 100644
index 0000000000..ae4f0655f8
--- /dev/null
+++ b/keyboards/wsk/g4m3ralpha/readme.md
@@ -0,0 +1,19 @@
+# G4M3R Alpha
+
+![Alpha](https://i.imgur.com/kETSyyg.png)
+
+A modification based on the 28-key, semi-ortho keyboard designed by PyroL.
+
+* Keyboard Maintainer: [Worldspawn00](https://www.github.com/Worldspawn00)
+* Hardware Supported: G4M3R Alpha PCB, Pro Micro
+* Hardware Availability: https://www.etsy.com/shop/WorldspawnsKeebs
+
+Make example for this keyboard (after setting up your build environment):
+
+ make wsk/g4m3ralpha:default
+
+Flashing example for this keyboard:
+
+ make wsk/g4m3ralpha:default:flash
+
+See [build environment setup](https://docs.qmk.fm/install-build-tools) then the [make instructions](https://docs.qmk.fm/faq/build-compile-qmk) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).