aboutsummaryrefslogtreecommitdiff
path: root/keyboards/handwired/CMD60/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/handwired/CMD60/README.md')
-rw-r--r--keyboards/handwired/CMD60/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/keyboards/handwired/CMD60/README.md b/keyboards/handwired/CMD60/README.md
new file mode 100644
index 000000000..83e371543
--- /dev/null
+++ b/keyboards/handwired/CMD60/README.md
@@ -0,0 +1,35 @@
1CMD60 keyboard firmware
2======================
3
4##CMD60
5
6This layout has been designed to optimize use of the left-hand, and it focussed specifically on programmers who work
7with text editors like SublimeText and Atom. It utilizes the power of Space_fn, and features a caps lock swap for Fn2
8and enter key on tap. These features allow you to keep your right hand on the mouse more and should enable you to
9achieve a higher level of productivity if you take the time to learn its function layers.
10
11## Quantum MK Firmware
12
13For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).
14
15## Building
16
17Download or clone the whole firmware and navigate to the keyboards/handwired/CMD60 folder.
18Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use
19the Teensy Loader to program your .hex file.
20
21Depending on which keymap you would like to use, you will have to compile slightly differently.
22
23### Default
24
25To build with the default keymap, simply run `make`.
26
27### Other Keymaps
28
29To build the firmware binary hex file with a keymap just do `make` with `keymap` option like:
30
31```
32$ make keymap=[default|jack|<name>]
33```
34
35Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/`