aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIBNobody <ibnobody@gmail.com>2016-09-13 22:05:10 -0500
committerIBNobody <ibnobody@gmail.com>2016-09-13 22:05:10 -0500
commit9c574b493c3d098d2c4f2475dfc1564a182acce0 (patch)
tree7d7084462fb64c5294c78bbb584db27ac1197166
parentcb1ac2a3edf637a3e2ecb53f0627212d1f5abb08 (diff)
downloadqmk_firmware-9c574b493c3d098d2c4f2475dfc1564a182acce0.tar.gz
qmk_firmware-9c574b493c3d098d2c4f2475dfc1564a182acce0.zip
Changed Docs, Moved RetroRefit to Handwired
-rw-r--r--keyboards/arrow_pad/readme.md113
-rw-r--r--keyboards/handwired/retro_refit/Makefile3
-rw-r--r--keyboards/handwired/retro_refit/config.h (renamed from keyboards/retro_refit/config.h)0
-rw-r--r--keyboards/handwired/retro_refit/keymaps/default/keymap.c (renamed from keyboards/retro_refit/keymaps/default/keymap.c)0
-rw-r--r--keyboards/handwired/retro_refit/readme.md60
-rw-r--r--keyboards/handwired/retro_refit/retro_refit.c (renamed from keyboards/retro_refit/retro_refit.c)0
-rw-r--r--keyboards/handwired/retro_refit/retro_refit.h (renamed from keyboards/retro_refit/retro_refit.h)0
-rw-r--r--keyboards/handwired/retro_refit/rules.mk (renamed from keyboards/retro_refit/rules.mk)0
-rw-r--r--keyboards/retro_refit/Makefile3
-rw-r--r--keyboards/retro_refit/readme.md26
-rw-r--r--keyboards/vision_division/readme.md6
11 files changed, 179 insertions, 32 deletions
diff --git a/keyboards/arrow_pad/readme.md b/keyboards/arrow_pad/readme.md
index 2e9a64f2e..d0d172272 100644
--- a/keyboards/arrow_pad/readme.md
+++ b/keyboards/arrow_pad/readme.md
@@ -1,13 +1,120 @@
1arrow_pad keyboard firmware 1arrow_pad keyboard firmware
2====================== 2======================
3 3
4## Keyboard Info
5
6The ArrowPad is a wired conversion that can be made to any stand-alone keypad. It uses two main layers - a standard numpad, and a more advanced arrow cluster navigator.
7
8The first 24-key ArrowPad was handwired, but the PCB was wired as listed below.
9
10```
11<Chip Ref Des> pin <Pin #>
12<Keycap Name> (Silkscreen Name if different) - <Switch Pin #>
13
14
15Note:
16U2 pin 2 is the Num Lock LED and is active low.
17
18U2 pin 1
19Clear (Num Lock) - 1
20Enter - 2
21Esc (ESC) - 2
22
23
24U2 pin 3
25- - 1
26
27U2 pin 4
287 - 2
298 - 2
309 - 2
31
32U2 pin 5
33* - 2
34Delete (BACK SPACE) - 2
35
36U2 pin 6
371 - 2
380 - 2
39. - 2
40, - 2
41
42U2 pin 7
434 - 2
445 - 2
456 - 2
46
47U2 pin 8
48Tab - 2
49= (/) - 2
50
51U2 pin 13
52Delete (BACK SPACE) - 1
539 - 1
546 - 1
553 - 1
56. - 1
57
58U2 pin 14
59Tab - 1
608 - 1
615 - 1
622 - 1
630 - 1
64
65U2 pin 15
66Esc (ESC) - 1
67= (/) - 1
68/ (*) - 1
697 - 1
704 - 1
711 - 1
72+ - 1
73
74U2 pin 16
75Enter - 1
76* (<--) - 1
77, - 1
78
79U2 pin 17
80Fn (#NAME?) - 1
81- - 2
82Clear (Num Lock) - 2
83
84U2 pin 18
85Fn (#NAME?) - 2
86* (<--) - 2
87+ - 2
883 - 2
892 - 2
90```
91
92More info can be found on [GeekHack](https://geekhack.org/index.php?topic=73632.msg1802497#msg1802497)
93
94The second ArrowPad was a conversion from a 21-key Genovation keypad. It used a 2 row x 11 column matrix.
95
96```
97#define KEYMAP( \
98 KM_ESC, KM_TAB, KM_BSL, KM_ARR, \
99 KM_NUM, KM_FSL, KM_AST, KM_MIN, \
100 KM___7, KM___8, KM___9, ___PLS, \
101 KM___4, KM___5, KM___6, KM_PLS, \
102 KM___1, KM___2, KM___3, ___ENT, \
103 KM___0, _____0, KM_DOT, KM_ENT \
104) { \
105 { KM_ESC, KM_TAB, KM_BSL, KM_ARR, KM___7, KM___8, KM___9, KM_PLS, KM___1, KM___2, KM___3, }, \
106 { KM_NUM, KM_FSL, KM_AST, KM_MIN, KM___4, KM___5, KM___6, KM_ENT, KC_NO, KM___0, KM_DOT, }, \
107}
108```
109
110
4## Quantum MK Firmware 111## Quantum MK Firmware
5 112
6For the full Quantum feature list, see [the parent readme.md](/readme.md). 113For the full Quantum feature list, see [the parent readme.md](/readme.md).
7 114
8## Building 115## Building
9 116
10Download or clone the whole firmware and navigate to the keyboards/arrow_pad 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. 117Download or clone the whole firmware and navigate to the keyboards/arrow_pad 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.
11 118
12Depending on which keymap you would like to use, you will have to compile slightly differently. 119Depending on which keymap you would like to use, you will have to compile slightly differently.
13 120
@@ -20,7 +127,7 @@ Several version of keymap are available in advance but you are recommended to de
20To build the firmware binary hex file with a keymap just do `make` with a keymap like this: 127To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
21 128
22``` 129```
23$ make [default|jack|<name>] 130$ make [default|pad_21|pad_24|<name>]
24``` 131```
25 132
26Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. \ No newline at end of file 133Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
diff --git a/keyboards/handwired/retro_refit/Makefile b/keyboards/handwired/retro_refit/Makefile
new file mode 100644
index 000000000..191c6bb66
--- /dev/null
+++ b/keyboards/handwired/retro_refit/Makefile
@@ -0,0 +1,3 @@
1ifndef MAKEFILE_INCLUDED
2 include ../../../Makefile
3endif \ No newline at end of file
diff --git a/keyboards/retro_refit/config.h b/keyboards/handwired/retro_refit/config.h
index f2194e550..f2194e550 100644
--- a/keyboards/retro_refit/config.h
+++ b/keyboards/handwired/retro_refit/config.h
diff --git a/keyboards/retro_refit/keymaps/default/keymap.c b/keyboards/handwired/retro_refit/keymaps/default/keymap.c
index 405402d5e..405402d5e 100644
--- a/keyboards/retro_refit/keymaps/default/keymap.c
+++ b/keyboards/handwired/retro_refit/keymaps/default/keymap.c
diff --git a/keyboards/handwired/retro_refit/readme.md b/keyboards/handwired/retro_refit/readme.md
new file mode 100644
index 000000000..9f10edf9f
--- /dev/null
+++ b/keyboards/handwired/retro_refit/readme.md
@@ -0,0 +1,60 @@
1retro_refit keyboard firmware
2======================
3
4## Keyboard Info
5
6The retro refit keyboard used a Teensy to replace the original controller on a 386 "laptop".
7
8http://imgur.com/a/08Fyj
9
10This keyboard uses a KEYMAP macro that is a great example of using a non-standard row-column matrix. The keyboard in question had 11 rows and 8 columns, but the rows were not all horizontal, and the columns were not all vertical. For example, row 2 contained "Print Screen", "N", "M", ",", ".", "/", "Right Shift", and"Left Alt". Column 0 contained "F6", "7", "O", "'", "Q", "D", "B", "Left Alt", "Up Arrow", and "Down Arrow".
11
12The macro makes programming the keys easier and in a more straight-forward manner because it realigns the keys into a 6x15 sensible keyboard layout instead of the obtuse 11x8 matrix. Each Kxy corrisponds to a key in row x column y.
13
14```
15#define KEYMAP( \
16 K77, K05, K04, K03, K02, K01, K00, KA7, KA6, KA5, KA4, KA3, KA2, K11, K94, \
17 K27, K76, K75, K74, K73, K72, K71, K70, K67, K66, K65, K64, K63, K62, KA1, \
18 K61, K60, K57, K56, K55, K54, K53, K52, K51, K50, K47, K46, K45, K97, \
19 K43, K42, K41, K40, K37, K36, K35, K34, K33, K32, K31, K30, K44, K87, \
20 K26, K24, K23, K22, K21, K20, K17, K16, K15, K14, K13, K12, KA0, K91, \
21 K10, K06, K25, K07, K86, K85, K95, K90, K93 \
22) { \
23{ KC_##K00, KC_##K01, KC_##K02, KC_##K03, KC_##K04, KC_##K05, KC_##K06, KC_##K07, }, \
24{ KC_##K10, KC_##K11, KC_##K12, KC_##K13, KC_##K14, KC_##K15, KC_##K16, KC_##K17, }, \
25{ KC_##K20, KC_##K21, KC_##K22, KC_##K23, KC_##K24, KC_##K25, KC_##K26, KC_##K27, }, \
26{ KC_##K30, KC_##K31, KC_##K32, KC_##K33, KC_##K34, KC_##K35, KC_##K36, KC_##K37, }, \
27{ KC_##K40, KC_##K41, KC_##K42, KC_##K43, KC_##K44, KC_##K45, KC_##K46, KC_##K47, }, \
28{ KC_##K50, KC_##K51, KC_##K52, KC_##K53, KC_##K54, KC_##K55, KC_##K56, KC_##K57, }, \
29{ KC_##K60, KC_##K61, KC_##K62, KC_##K63, KC_##K64, KC_##K65, KC_##K66, KC_##K67, }, \
30{ KC_##K70, KC_##K71, KC_##K72, KC_##K73, KC_##K74, KC_##K75, KC_##K76, KC_##K77, }, \
31{ KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_##K85, KC_##K86, KC_##K87, }, \
32{ KC_##K90, KC_##K91, KC_NO, KC_##K93, KC_##K94, KC_##K95, KC_NO, KC_##K97, }, \
33{ KC_##KA0, KC_##KA1, KC_##KA2, KC_##KA3, KC_##KA4, KC_##KA5, KC_##KA6, KC_##KA7, } \
34}
35```
36
37
38## Quantum MK Firmware
39
40For the full Quantum feature list, see [the parent readme.md](/readme.md).
41
42## Building
43
44Download or clone the whole firmware and navigate to the keyboards/retro_refit 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.
45
46Depending on which keymap you would like to use, you will have to compile slightly differently.
47
48### Default
49To build with the default keymap, simply run `make default`.
50
51### Other Keymaps
52Several 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` and see keymap document (you can find in top readme.md) and existent keymap files.
53
54To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
55
56```
57$ make [default|jack|<name>]
58```
59
60Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. \ No newline at end of file
diff --git a/keyboards/retro_refit/retro_refit.c b/keyboards/handwired/retro_refit/retro_refit.c
index 3d610eba3..3d610eba3 100644
--- a/keyboards/retro_refit/retro_refit.c
+++ b/keyboards/handwired/retro_refit/retro_refit.c
diff --git a/keyboards/retro_refit/retro_refit.h b/keyboards/handwired/retro_refit/retro_refit.h
index 109acdc39..109acdc39 100644
--- a/keyboards/retro_refit/retro_refit.h
+++ b/keyboards/handwired/retro_refit/retro_refit.h
diff --git a/keyboards/retro_refit/rules.mk b/keyboards/handwired/retro_refit/rules.mk
index 10fbfa5c9..10fbfa5c9 100644
--- a/keyboards/retro_refit/rules.mk
+++ b/keyboards/handwired/retro_refit/rules.mk
diff --git a/keyboards/retro_refit/Makefile b/keyboards/retro_refit/Makefile
deleted file mode 100644
index 4e2a6f00f..000000000
--- a/keyboards/retro_refit/Makefile
+++ /dev/null
@@ -1,3 +0,0 @@
1ifndef MAKEFILE_INCLUDED
2 include ../../Makefile
3endif \ No newline at end of file
diff --git a/keyboards/retro_refit/readme.md b/keyboards/retro_refit/readme.md
deleted file mode 100644
index 77df861ce..000000000
--- a/keyboards/retro_refit/readme.md
+++ /dev/null
@@ -1,26 +0,0 @@
1retro_refit keyboard firmware
2======================
3
4## Quantum MK Firmware
5
6For the full Quantum feature list, see [the parent readme.md](/readme.md).
7
8## Building
9
10Download or clone the whole firmware and navigate to the keyboards/retro_refit 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.
11
12Depending on which keymap you would like to use, you will have to compile slightly differently.
13
14### Default
15To build with the default keymap, simply run `make default`.
16
17### Other Keymaps
18Several 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` and see keymap document (you can find in top readme.md) and existent keymap files.
19
20To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
21
22```
23$ make [default|jack|<name>]
24```
25
26Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. \ No newline at end of file
diff --git a/keyboards/vision_division/readme.md b/keyboards/vision_division/readme.md
index 0a637fd06..de200d7c5 100644
--- a/keyboards/vision_division/readme.md
+++ b/keyboards/vision_division/readme.md
@@ -1,6 +1,12 @@
1vision_division keyboard firmware 1vision_division keyboard firmware
2====================== 2======================
3 3
4## Keyboard Info
5
6[See this thread.](https://geekhack.org/index.php?topic=83692.msg2227856#msg2227856)
7
8Vision/Division is a full size or split keyboard that can be customized due to its pcb.
9
4## Quantum MK Firmware 10## Quantum MK Firmware
5 11
6For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). 12For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).