refactored cyclops keyboard project (#4734)

[qmk_firmware.git] / keyboards / westfoxtrot / cyclops / readme.md

diff --git a/keyboards/westfoxtrot/cyclops/readme.md b/keyboards/westfoxtrot/cyclops/readme.md
new file mode 100644 (file)
index 0000000..e026c41
--- /dev/null
+++ b/keyboards/westfoxtrot/cyclops/readme.md
@@ -0,0 +1,15 @@
+# cyclops
+
+![cyclops](https://github.com/westfoxtrot/Cyclops)
+
+66% Alps Keyboard in ISO layout.
+
+ Keyboard Maintainer: [westfoxtrot](https://github.com/westfoxtrot)  
+ Hardware Supported: Cyclops (AEKISO66) PCB  
+ Hardware Availability: Files released here (https://github.com/westfoxtrot/Cyclops)  
+
+Make example for this keyboard (after setting up your build environment):
+
+    make westfoxtrot/cyclops: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).