summaryrefslogtreecommitdiffstats
path: root/keyboards/slz40/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/slz40/readme.md')
-rw-r--r--keyboards/slz40/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/slz40/readme.md b/keyboards/slz40/readme.md
new file mode 100644
index 0000000000..d710f597f9
--- /dev/null
+++ b/keyboards/slz40/readme.md
@@ -0,0 +1,19 @@
+# slz40
+
+![SLZ40](https://imgur.com/kgXfEBR.jpg)
+
+PCB and keymap files for the SLZ40, a 40s style keyboard with numbers for Zhuyin input.
+
+* Keyboard Maintainer: [SithLord](https://github.com/sithlord121/slz40)
+* Hardware Supported: ProMicro or similar controller is required.
+* Hardware Availability: PCB files can be found at https://github.com/sithlord121/slz40
+
+Make example for this keyboard (after setting up your build environment):
+
+ make slz40:default
+
+Flashing example for this keyboard:
+
+ make slz40: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).