summaryrefslogtreecommitdiffstats
path: root/keyboards/alf/x11/readme.md
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-02-19 20:57:15 -0800
committerDrashna Jaelre <drashna@live.com>2019-02-19 20:57:15 -0800
commit67495ae24a98a2d7965ba5dda9b1d133caf606ca (patch)
treea29830c94dde2e13786b672ee58cb9c480cc78ce /keyboards/alf/x11/readme.md
parent8ae83b490eb3f8ebc696c9531dff49bdfecd26ed (diff)
[Keyboard] Alf X1.1 QMK Support (#5189)
* initial commit * get rid of vanilla cookie cutter code and replace with more correct info * edit config file for pins and switch matrix size * turn on bootmagic lite, and backlight/rgb settings * copy pasta switch matrix from noroads tool * create an appropriate keymap (copy pasta) * disable some features to decrease firmware file size * add qmk configurator support * add in support for caps lock, scroll lock, and num lock leds
Diffstat (limited to 'keyboards/alf/x11/readme.md')
-rw-r--r--keyboards/alf/x11/readme.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/keyboards/alf/x11/readme.md b/keyboards/alf/x11/readme.md
new file mode 100644
index 0000000000..b403a0952a
--- /dev/null
+++ b/keyboards/alf/x11/readme.md
@@ -0,0 +1,13 @@
+# Alf X1.1
+
+TKL Keyboard made by Alf
+
+Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+Hardware Supported: Alf X1.1 PCB
+Hardware Availability: [Massdrop](https://www.massdrop.com/buy/alf-studio-x1-1-custom-mechanical-keyboard-kit)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make alf/x11: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).