Makefile redo & other features (#395)

* .build containment implemented * no destructive variable setting - builds in either folder * make from 3 places * cleans before each build * make from root with keyboard=keyboard, keymap=keymap * make from keyboard/keyboard with keymap=keymap * make from keymaps/keymap * only implemented on planck * adds color diag to avr-gcc * makefiles for all plancks, clean-up * quick build-all makefile for plancks * reformatting of make output (colors) * color toggle, tmk path corrections * correct if statement for color * move config.h to main makefile, updates preonic, atomic * format update, all keyboards targets * makefile optional for build all target, alps and arrow_pad updated * alps updated * make planck default, trying out travis recipe for all-keyboards * all-keymaps target, different travis recipe * updates alps64 * updates keyboards to new format * updates clue* projects * all projects updated, specialise EZ .hex, let .hex through * updates travis * automatically find root, keyboard, keymap * silent echo, cleaned-up mass make output * updates all keyboards' .hex files except EZ * Rename Bantam44.c to bantam44.c * Rename Bantam44.h to bantam44.h * nananana * adds six key keyboard * does same to ez as rest * updates send_string example * brings ergodox_ez up to date * updates template/new project script * adds sixkeyboard * adds readme for sixkeyboard * adds sixkeyboard to travis * filenames, gitignore mess * define clock prescaler stuff manually * make quick, size test example * documentation and dfu-no-build
author: Jack Humbert <jack.humb@gmail.com> 2016-06-11 13:31:31 -0400
committer: GitHub <noreply@github.com> 2016-06-11 13:31:31 -0400
commit: d9e4dad0a828a8a904f44dda090a4d6d08fe2948 (patch)
tree: d6f002712c22e8cf4523e04a9da889c7ec379d6b /keyboard/gh60/README.md
parent: a5d638ad3091e2d553eaa04d933df28eeced5a8b (diff)
download: qmk_firmware-d9e4dad0a828a8a904f44dda090a4d6d08fe2948.tar.gz
qmk_firmware-d9e4dad0a828a8a904f44dda090a4d6d08fe2948.zip
1 files changed, 60 insertions, 141 deletions
diff --git a/keyboard/gh60/README.md b/keyboard/gh60/README.md
index 41a757ea3..bf209be8c 100644
--- a/keyboard/gh60/README.md
+++ b/keyboard/gh60/README.md
@@ -1,141 +1,60 @@
-GH60 keyboard firmware
+## gh60 Rev C keyboard firmware
-======================
-DIY compact keyboard designed and run by komar007 and Geekhack community.
+![gh60 Rev C PCB](gh60revc.jpg)
- Both Rev.A and Rev.B PCB are supported by one firmware binary(issue #64)
+    /* Column pin configuration
+    * col: 0   1   2   3   4   5   6   7   8   9   10  11  12  13
-## GH60 Resources
+    * pin: F0  F1  E6  C7  C6  B6  D4  B1  B7  B5  B4  D7  D6  B3  (Rev.C)
- [KOMAR's project page](http://blog.komar.be/projects/gh60-programmable-keyboard/)
+    */
- [Prototyping](http://geekhack.org/index.php?topic=34959.0)
+     
- [Rev.A PCB test](http://geekhack.org/index.php?topic=37570.0)
+    /* Row pin configuration
- [Rev.B PCB test](http://geekhack.org/index.php?topic=50685.0)
+    * row: 0   1   2   3   4
- [Group buy](http://geekhack.org/index.php?topic=41464.0)
+    * pin: D0  D1  D2  D3  D5
+    */
+     
-## Build
+    GPIO pads
-Move to this directory then just run `make` like:
+    0 F7 WASD LEDs
+    1 F6 ESC LED
-    $ make
+    2 F5 FN LED
+    3 F4 POKER Arrow LEDs
-Use `make -f Makefile.pjrc` if you want to use PJRC stack but I find no reason to do so now.
+     
+    B2 Capslock LED
+    B0 not connected
-## Keymap
+        
-Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` in the keymaps folder, and see keymap document(you can find in top README.md) and existent keymap files.
+Functions to controls LED clusters
+        
-To build firmware binary hex file with a certain keymap just do `make` with `KEYMAP` option like:
+    gh60_caps_led_on()
+    gh60_poker_leds_on()
-    $ make KEYMAP=[poker|poker_set|poker_bit|plain|hasu|spacefn|hhkb|<name>]
+    gh60_fn_led_on()
+    gh60_esc_led_on()
+    gh60_wasd_leds_on()
-### 1  Poker
+    
-[poker.c](keymaps/poker.c) emulates original Poker layers
+    gh60_caps_led_off()
-while both [poker_bit.c](keymaps/poker_bit.c) and [poker_set.c](keymaps/poker_set.c) implement the same layout in different ways and they fix a minor issue of original Poker and enhance arrow keys.
+    gh60_poker_leds_off()
+    gh60_fn_led_off()
-    Fn + Esc = `
+    gh60_esc_led_off()
-    Fn + {left, down, up, right}  = {home, pgdown, pgup, end}
+    gh60_wasd_leds_off()
+        
-#### 1.0 Default layer
+======================
-    ,-----------------------------------------------------------.
-    |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
+## Quantum MK Firmware
-    |-----------------------------------------------------------|
-    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
+For the full Quantum feature list, see [the parent README.md](/README.md).
-    |-----------------------------------------------------------|
-    |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
+## Building
-    |-----------------------------------------------------------|
-    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
+Download or clone the whole firmware and navigate to the keyboard/gh60_rev_c folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file. 
-    |-----------------------------------------------------------|
-    |Ctrl|Gui |Alt |      Space             |Fn  |Gui |App |Ctrl|
+Depending on which keymap you would like to use, you will have to compile slightly differently.
-    `-----------------------------------------------------------'
-#### 1.1 Poker Fn layer
+### Default
-    ,-----------------------------------------------------------.
+To build with the default keymap, simply run `make`.
-    |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|       |
-    |-----------------------------------------------------------|
+### Other Keymaps
-    |     |FnQ| Up|   |   |   |   |   |   |Cal|   |Hom|Ins|     |
+Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` in the keymaps folder, and see keymap document (you can find in top README.md) and existent keymap files.
-    |-----------------------------------------------------------|
-    |      |Lef|Dow|Rig|   |   |Psc|Slk|Pau|   |Tsk|End|        |
+To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:
-    |-----------------------------------------------------------|
+```
-    |        |Del|   |Web|Mut|VoU|VoD|   |PgU|PgD|Del|   Up     |
+$ make KEYMAP=[default|jack|<name>]
-    |-----------------------------------------------------------|
+```
-    |    |    |    |         FnS            |Fn  |Left|Down|Righ|
+Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
-    `-----------------------------------------------------------'
-### 2. Plain
-Without any Fn layer this will be useful if you want to use key remapping tool like AHK on host.
-See [plain.c](keymaps/plain.c) for detail.
-#### 1.0 Plain Default layer
-    ,-----------------------------------------------------------.
-    |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
-    |-----------------------------------------------------------|
-    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
-    |-----------------------------------------------------------|
-    |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
-    |-----------------------------------------------------------|
-    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
-    |-----------------------------------------------------------|
-    |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Ctrl|
-    `-----------------------------------------------------------'
-### 3. Hasu
-This is my favorite keymap with HHKB Fn, Vi cursor and Mousekey layer. See [hasu.c](keymaps/hasu.c) for detail.
-### 4. SpaceFN
-This layout proposed by spiceBar uses space bar to change layer with using Dual role key technique. See [spacefn.c](keymaps/spacefn.c) and [SpaceFN discussion](http://geekhack.org/index.php?topic=51069.0).
-#### 4.0 Default layer
-    ,-----------------------------------------------------------.
-    |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
-    |-----------------------------------------------------------|
-    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
-    |-----------------------------------------------------------|
-    |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
-    |-----------------------------------------------------------|
-    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
-    |-----------------------------------------------------------|
-    |Ctrl|Gui |Alt |      Space/Fn          |Alt |Gui |App |Ctrl|
-    `-----------------------------------------------------------'
-#### 4.1 SpaceFN layer
-    ,-----------------------------------------------------------.
-    |`  | F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
-    |-----------------------------------------------------------|
-    |     |   |   |   |   |   |   |Hom|Up |End|Psc|Slk|Pau|Ins  |
-    |-----------------------------------------------------------|
-    |      |   |   |   |   |   |PgU|Lef|Dow|Rig|   |   |        |
-    |-----------------------------------------------------------|
-    |        |   |   |   |   |Spc|PgD|`  |~  |   |   |          |
-    |-----------------------------------------------------------|
-    |    |    |    |            Fn          |    |    |    |    |
-    `-----------------------------------------------------------'
-### 5. HHKB
-[hhkb.c](keymaps/hhkb.c) emulates original HHKB layers.
-#### 5.0: Default layer
-    ,-----------------------------------------------------------.
-    |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|  \|  `|
-    |-----------------------------------------------------------|
-    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|Bspc |
-    |-----------------------------------------------------------|
-    |Ctrl  |  A|  S|  D|  F|  G|  H|  J|  K|  L|Fn3|  '|Return  |
-    |-----------------------------------------------------------|
-    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift |Fn |
-    |-----------------------------------------------------------|
-    |    |Gui |Alt |      Space             |    |Alt |Gui |    |
-    `-----------------------------------------------------------'
-#### 5.1: HHKB Fn layer
-    ,-----------------------------------------------------------.
-    |Pwr| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
-    |-----------------------------------------------------------|
-    |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |     |
-    |-----------------------------------------------------------|
-    |      |VoD|VoU|Mut|Ejc|   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
-    |-----------------------------------------------------------|
-    |        |   |   |   |   |   |  +|  -|End|PgD|Dow|      |   |
-    |-----------------------------------------------------------|
-    |    |    |    |                        |    |    |    |    |
-    `-----------------------------------------------------------'
author	Jack Humbert <jack.humb@gmail.com>	2016-06-11 13:31:31 -0400
committer	GitHub <noreply@github.com>	2016-06-11 13:31:31 -0400
commit	d9e4dad0a828a8a904f44dda090a4d6d08fe2948 (patch)
tree	d6f002712c22e8cf4523e04a9da889c7ec379d6b /keyboard/gh60/README.md
parent	a5d638ad3091e2d553eaa04d933df28eeced5a8b (diff)
download	qmk_firmware-d9e4dad0a828a8a904f44dda090a4d6d08fe2948.tar.gz qmk_firmware-d9e4dad0a828a8a904f44dda090a4d6d08fe2948.zip

diff --git a/keyboard/gh60/README.md b/keyboard/gh60/README.md index 41a757ea3..bf209be8c 100644 --- a/keyboard/gh60/README.md +++ b/keyboard/gh60/README.md
@@ -1,141 +1,60 @@
1	GH60 keyboard firmware	1	## gh60 Rev C keyboard firmware
2	======================	2
3	DIY compact keyboard designed and run by komar007 and Geekhack community.	3	![gh60 Rev C PCB](gh60revc.jpg)
4		4
5	- Both Rev.A and Rev.B PCB are supported by one firmware binary(issue #64)	5	/* Column pin configuration
6		6	* col: 0 1 2 3 4 5 6 7 8 9 10 11 12 13
7	## GH60 Resources	7	* pin: F0 F1 E6 C7 C6 B6 D4 B1 B7 B5 B4 D7 D6 B3 (Rev.C)
8	- [KOMAR's project page](http://blog.komar.be/projects/gh60-programmable-keyboard/)	8	*/
9	- [Prototyping](http://geekhack.org/index.php?topic=34959.0)	9
10	- [Rev.A PCB test](http://geekhack.org/index.php?topic=37570.0)	10	/* Row pin configuration
11	- [Rev.B PCB test](http://geekhack.org/index.php?topic=50685.0)	11	* row: 0 1 2 3 4
12	- [Group buy](http://geekhack.org/index.php?topic=41464.0)	12	* pin: D0 D1 D2 D3 D5
13		13	*/
14		14
15	## Build	15	GPIO pads
16	Move to this directory then just run `make` like:	16	0 F7 WASD LEDs
17		17	1 F6 ESC LED
18	$ make	18	2 F5 FN LED
19		19	3 F4 POKER Arrow LEDs
20	Use `make -f Makefile.pjrc` if you want to use PJRC stack but I find no reason to do so now.	20
21		21	B2 Capslock LED
22		22	B0 not connected
23	## Keymap	23
24	Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` in the keymaps folder, and see keymap document(you can find in top README.md) and existent keymap files.	24	Functions to controls LED clusters
25		25
26	To build firmware binary hex file with a certain keymap just do `make` with `KEYMAP` option like:	26	gh60_caps_led_on()
27		27	gh60_poker_leds_on()
28	$ make KEYMAP=[poker\|poker_set\|poker_bit\|plain\|hasu\|spacefn\|hhkb\|<name>]	28	gh60_fn_led_on()
29		29	gh60_esc_led_on()
30		30	gh60_wasd_leds_on()
31	### 1 Poker	31
32	[poker.c](keymaps/poker.c) emulates original Poker layers	32	gh60_caps_led_off()
33	while both [poker_bit.c](keymaps/poker_bit.c) and [poker_set.c](keymaps/poker_set.c) implement the same layout in different ways and they fix a minor issue of original Poker and enhance arrow keys.	33	gh60_poker_leds_off()
34		34	gh60_fn_led_off()
35	Fn + Esc = `	35	gh60_esc_led_off()
36	Fn + {left, down, up, right} = {home, pgdown, pgup, end}	36	gh60_wasd_leds_off()
37		37
38	#### 1.0 Default layer	38	======================
39	,-----------------------------------------------------------.	39
40	\| `\| 1\| 2\| 3\| 4\| 5\| 6\| 7\| 8\| 9\| 0\| -\| =\|Backsp \|	40	## Quantum MK Firmware
41	\|-----------------------------------------------------------\|	41
42	\|Tab \| Q\| W\| E\| R\| T\| Y\| U\| I\| O\| P\| [\| ]\| \\|	42	For the full Quantum feature list, see [the parent README.md](/README.md).
43	\|-----------------------------------------------------------\|	43
44	\|Caps \| A\| S\| D\| F\| G\| H\| J\| K\| L\| ;\| '\|Return \|	44	## Building
45	\|-----------------------------------------------------------\|	45
46	\|Shift \| Z\| X\| C\| V\| B\| N\| M\| ,\| .\| /\|Shift \|	46	Download or clone the whole firmware and navigate to the keyboard/gh60_rev_c folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file.
47	\|-----------------------------------------------------------\|	47
48	\|Ctrl\|Gui \|Alt \| Space \|Fn \|Gui \|App \|Ctrl\|	48	Depending on which keymap you would like to use, you will have to compile slightly differently.
49	`-----------------------------------------------------------'	49
50	#### 1.1 Poker Fn layer	50	### Default
51	,-----------------------------------------------------------.	51	To build with the default keymap, simply run `make`.
52	\|Esc\| F1\| F2\| F3\| F4\| F5\| F6\| F7\| F8\| F9\|F10\|F11\|F12\| \|	52
53	\|-----------------------------------------------------------\|	53	### Other Keymaps
54	\| \|FnQ\| Up\| \| \| \| \| \| \|Cal\| \|Hom\|Ins\| \|	54	Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` in the keymaps folder, and see keymap document (you can find in top README.md) and existent keymap files.
55	\|-----------------------------------------------------------\|	55
56	\| \|Lef\|Dow\|Rig\| \| \|Psc\|Slk\|Pau\| \|Tsk\|End\| \|	56	To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:
57	\|-----------------------------------------------------------\|	57	```
58	\| \|Del\| \|Web\|Mut\|VoU\|VoD\| \|PgU\|PgD\|Del\| Up \|	58	$ make KEYMAP=[default\|jack\|<name>]
59	\|-----------------------------------------------------------\|	59	```
60	\| \| \| \| FnS \|Fn \|Left\|Down\|Righ\|	60	Keymaps follow the format __\<name\>.c__ and are stored in the `keymaps` folder.
61	`-----------------------------------------------------------'
62
63
64	### 2. Plain
65	Without any Fn layer this will be useful if you want to use key remapping tool like AHK on host.
66	See [plain.c](keymaps/plain.c) for detail.
67
68	#### 1.0 Plain Default layer
69	,-----------------------------------------------------------.
70	\|Esc\| 1\| 2\| 3\| 4\| 5\| 6\| 7\| 8\| 9\| 0\| -\| =\|Backsp \|
71	\|-----------------------------------------------------------\|
72	\|Tab \| Q\| W\| E\| R\| T\| Y\| U\| I\| O\| P\| [\| ]\| \\|
73	\|-----------------------------------------------------------\|
74	\|Caps \| A\| S\| D\| F\| G\| H\| J\| K\| L\| ;\| '\|Return \|
75	\|-----------------------------------------------------------\|
76	\|Shift \| Z\| X\| C\| V\| B\| N\| M\| ,\| .\| /\|Shift \|
77	\|-----------------------------------------------------------\|
78	\|Ctrl\|Gui \|Alt \| Space \|Alt \|Gui \|App \|Ctrl\|
79	`-----------------------------------------------------------'
80
81
82	### 3. Hasu
83	This is my favorite keymap with HHKB Fn, Vi cursor and Mousekey layer. See [hasu.c](keymaps/hasu.c) for detail.
84
85
86	### 4. SpaceFN
87	This layout proposed by spiceBar uses space bar to change layer with using Dual role key technique. See [spacefn.c](keymaps/spacefn.c) and [SpaceFN discussion](http://geekhack.org/index.php?topic=51069.0).
88
89	#### 4.0 Default layer
90	,-----------------------------------------------------------.
91	\|Esc\| 1\| 2\| 3\| 4\| 5\| 6\| 7\| 8\| 9\| 0\| -\| =\|Backsp \|
92	\|-----------------------------------------------------------\|
93	\|Tab \| Q\| W\| E\| R\| T\| Y\| U\| I\| O\| P\| [\| ]\| \\|
94	\|-----------------------------------------------------------\|
95	\|Caps \| A\| S\| D\| F\| G\| H\| J\| K\| L\| ;\| '\|Return \|
96	\|-----------------------------------------------------------\|
97	\|Shift \| Z\| X\| C\| V\| B\| N\| M\| ,\| .\| /\|Shift \|
98	\|-----------------------------------------------------------\|
99	\|Ctrl\|Gui \|Alt \| Space/Fn \|Alt \|Gui \|App \|Ctrl\|
100	`-----------------------------------------------------------'
101	#### 4.1 SpaceFN layer
102	,-----------------------------------------------------------.
103	\|` \| F1\| F2\| F3\| F4\| F5\| F6\| F7\| F8\| F9\|F10\|F11\|F12\|Delete \|
104	\|-----------------------------------------------------------\|
105	\| \| \| \| \| \| \| \|Hom\|Up \|End\|Psc\|Slk\|Pau\|Ins \|
106	\|-----------------------------------------------------------\|
107	\| \| \| \| \| \| \|PgU\|Lef\|Dow\|Rig\| \| \| \|
108	\|-----------------------------------------------------------\|
109	\| \| \| \| \| \|Spc\|PgD\|` \|~ \| \| \| \|
110	\|-----------------------------------------------------------\|
111	\| \| \| \| Fn \| \| \| \| \|
112	`-----------------------------------------------------------'
113
114
115	### 5. HHKB
116	[hhkb.c](keymaps/hhkb.c) emulates original HHKB layers.
117	#### 5.0: Default layer
118	,-----------------------------------------------------------.
119	\|Esc\| 1\| 2\| 3\| 4\| 5\| 6\| 7\| 8\| 9\| 0\| -\| =\| \\| `\|
120	\|-----------------------------------------------------------\|
121	\|Tab \| Q\| W\| E\| R\| T\| Y\| U\| I\| O\| P\| [\| ]\|Bspc \|
122	\|-----------------------------------------------------------\|
123	\|Ctrl \| A\| S\| D\| F\| G\| H\| J\| K\| L\|Fn3\| '\|Return \|
124	\|-----------------------------------------------------------\|
125	\|Shift \| Z\| X\| C\| V\| B\| N\| M\| ,\| .\| /\|Shift \|Fn \|
126	\|-----------------------------------------------------------\|
127	\| \|Gui \|Alt \| Space \| \|Alt \|Gui \| \|
128	`-----------------------------------------------------------'
129	#### 5.1: HHKB Fn layer
130	,-----------------------------------------------------------.
131	\|Pwr\| F1\| F2\| F3\| F4\| F5\| F6\| F7\| F8\| F9\|F10\|F11\|F12\|Ins\|Del\|
132	\|-----------------------------------------------------------\|
133	\|Caps \| \| \| \| \| \| \| \|Psc\|Slk\|Pus\|Up \| \| \|
134	\|-----------------------------------------------------------\|
135	\| \|VoD\|VoU\|Mut\|Ejc\| \| *\| /\|Hom\|PgU\|Lef\|Rig\|Enter \|
136	\|-----------------------------------------------------------\|
137	\| \| \| \| \| \| \| +\| -\|End\|PgD\|Dow\| \| \|
138	\|-----------------------------------------------------------\|
139	\| \| \| \| \| \| \| \| \|
140	`-----------------------------------------------------------'
141