summaryrefslogtreecommitdiffstats
path: root/keyboard/ghost_squid/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboard/ghost_squid/README.md')
-rw-r--r--keyboard/ghost_squid/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboard/ghost_squid/README.md b/keyboard/ghost_squid/README.md
new file mode 100644
index 0000000000..dda67e6ba1
--- /dev/null
+++ b/keyboard/ghost_squid/README.md
@@ -0,0 +1,20 @@
+The Ghost Squid controller
+==========================
+Custom controller for the Cooler Master QuickFire XT keyboard designed by bpiphany.
+
+*Note that this is not the official firmware*
+
+Build
+-----
+Move to this directory then just run `make` like:
+
+ $ make -f Makefile.lufa
+
+At the moment only the LUFA stack is supported.
+
+
+Bootloader
+---------
+To enter bootloader by hardware use a magnet above the controller before connecting the usb cable.
+
+It is still possible to use Boot Magic and Command (LSFT+RSFT+PAUS) to access the bootloader though.