3 files changed, 30 insertions, 68 deletions
diff --git a/keyboards/atomic/readme.md b/keyboards/atomic/readme.md
index 674dcf113..1224c415f 100644
--- a/keyboards/atomic/readme.md
+++ b/keyboards/atomic/readme.md
@@ -1,26 +1,16 @@
-Atomic keyboard firmware
+Atomic
-======================
+===
-DIY/Assembled ortholinear 60% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
-## Quantum MK Firmware
+![Atomic](http://i.imgur.com/3gNDJAh.jpg)
-For the full Quantum feature list, see [the parent readme.md](/readme.md).
+A compact 60% (15x5) ortholinear keyboard kit made and sold by OLKB. [More info on qmk.fm](http://qmk.fm/atomic/)
-## Building
+Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert)
+Hardware Supported: Atomic PCB rev1, Teensy 2.0
+Hardware Availability: no longer available
-Download or clone the whole firmware and navigate to the keyboards/atomic folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use `make dfu` to program your PCB once you hit the reset button. 
+Make example for this keyboard (after setting up your build environment):
-Depending on which keymap you would like to use, you will have to compile slightly differently.
+    make atomic-default
-### Default
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
+\ No newline at end of file
-To build with the default keymap, simply run `make default`.
-### Other Keymaps
-Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a file in the keymaps folder named `<name>.c` and see keymap document (you can find in top readme.md) and existent keymap files.
-To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
-```
-$ make [default|jack|<name>]
-```
-Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
diff --git a/keyboards/planck/readme.md b/keyboards/planck/readme.md
index 4b24a690e..b1a8c23b2 100644
--- a/keyboards/planck/readme.md
+++ b/keyboards/planck/readme.md
@@ -1,33 +1,16 @@
-Planck keyboard firmware
+Planck
-======================
+===
-DIY/Assembled compact ortholinear 40% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
-## Quantum MK Firmware
+![Planck](http://i.imgur.com/q2M3uEU.jpg)
-For the full Quantum feature list, see [the parent readme.md](/readme.md).
+A compact 40% (12x4) ortholinear keyboard kit made and sold by OLKB and Massdrop. [More info on qmk.fm](http://qmk.fm/planck/)
-## Building
+Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert)
+Hardware Supported: Planck PCB rev1, rev2, rev3, rev4, Teensy 2.0
+Hardware Availability: [OLKB.com](https://olkb.com), [Massdrop](https://www.massdrop.com/buy/planck-mechanical-keyboard?mode=guest_open)
-Download or clone the whole firmware and navigate to the keyboards/planck folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use `make dfu` to program your PCB once you hit the reset button. 
+Make example for this keyboard (after setting up your build environment):
-Depending on which keymap you would like to use, you will have to compile slightly differently.
+    make planck-rev4-default
-### Default
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
+\ No newline at end of file
-To build with the default keymap, simply run `make default`.
-### Other Keymaps
-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.
-To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
-```
-$ make [default|jack|<name>]
-```
-Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
-### Notable forks (which some of the keymap files are from)
- [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)
- [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c)
- [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck)
- [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid)
diff --git a/keyboards/preonic/readme.md b/keyboards/preonic/readme.md
index 10763ee97..2a4ccd84d 100644
--- a/keyboards/preonic/readme.md
+++ b/keyboards/preonic/readme.md
@@ -1,27 +1,16 @@
-Preonic keyboard firmware
+Preonic
-======================
+===
-DIY/Assembled compact ortholinear 50% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
-## Quantum MK Firmware
+![Preonic](http://i.imgur.com/EDWQbB0.jpg)
-For the full Quantum feature list, see [the parent readme.md](/readme.md).
+A compact 50% (12x5) ortholinear keyboard kit made and sold by OLKB and Massdrop. [More info on qmk.fm](http://qmk.fm/preonic/)
-## Building
+Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert)
+Hardware Supported: Preonic PCB rev1, Teensy 2.0
+Hardware Availability: [OLKB.com](https://olkb.com/preonic/), [Massdrop](https://www.massdrop.com/buy/preonic-mechanical-keyboard?mode=guest_open)
-Download or clone the whole firmware and navigate to the keyboards/preonic folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use `make dfu` to program your PCB once you hit the reset button. 
+Make example for this keyboard (after setting up your build environment):
-Depending on which keymap you would like to use, you will have to compile slightly differently.
+    make preonic-default
-### Default
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
+\ No newline at end of file
-To build with the default keymap, simply run `make default`.
-### Other Keymaps
-Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap, create a file in the keymaps folder named `<name>.c` and see keymap document (you can find in top readme.md) and existent keymap files.
-To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
-```
-$ make [default|jack|<name>]
-```
-Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.

diff --git a/keyboards/atomic/readme.md b/keyboards/atomic/readme.md index 674dcf113..1224c415f 100644 --- a/keyboards/atomic/readme.md +++ b/keyboards/atomic/readme.md
@@ -1,26 +1,16 @@
1	Atomic keyboard firmware	1	Atomic
2	======================	2	===
3	DIY/Assembled ortholinear 60% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
4		3
5	## Quantum MK Firmware	4	![Atomic](http://i.imgur.com/3gNDJAh.jpg)
6		5
7	For the full Quantum feature list, see [the parent readme.md](/readme.md).	6	A compact 60% (15x5) ortholinear keyboard kit made and sold by OLKB. [More info on qmk.fm](http://qmk.fm/atomic/)
8		7
9	## Building	8	Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert)
		9	Hardware Supported: Atomic PCB rev1, Teensy 2.0
		10	Hardware Availability: no longer available
10		11
11	Download or clone the whole firmware and navigate to the keyboards/atomic folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use `make dfu` to program your PCB once you hit the reset button.	12	Make example for this keyboard (after setting up your build environment):
12		13
13	Depending on which keymap you would like to use, you will have to compile slightly differently.	14	make atomic-default
14		15
15	### Default	16	See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. \ No newline at end of file
16	To build with the default keymap, simply run `make default`.
17
18	### Other Keymaps
19	Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a file in the keymaps folder named `<name>.c` and see keymap document (you can find in top readme.md) and existent keymap files.
20
21	To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
22
23	```
24	$ make [default\|jack\|<name>]
25	```
26	Keymaps follow the format __\<name\>.c__ and are stored in the `keymaps` folder.


diff --git a/keyboards/planck/readme.md b/keyboards/planck/readme.md index 4b24a690e..b1a8c23b2 100644 --- a/keyboards/planck/readme.md +++ b/keyboards/planck/readme.md
@@ -1,33 +1,16 @@
1	Planck keyboard firmware	1	Planck
2	======================	2	===
3	DIY/Assembled compact ortholinear 40% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
4		3
5	## Quantum MK Firmware	4	![Planck](http://i.imgur.com/q2M3uEU.jpg)
6		5
7	For the full Quantum feature list, see [the parent readme.md](/readme.md).	6	A compact 40% (12x4) ortholinear keyboard kit made and sold by OLKB and Massdrop. [More info on qmk.fm](http://qmk.fm/planck/)
8		7
9	## Building	8	Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert)
		9	Hardware Supported: Planck PCB rev1, rev2, rev3, rev4, Teensy 2.0
		10	Hardware Availability: [OLKB.com](https://olkb.com), [Massdrop](https://www.massdrop.com/buy/planck-mechanical-keyboard?mode=guest_open)
10		11
11	Download or clone the whole firmware and navigate to the keyboards/planck folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use `make dfu` to program your PCB once you hit the reset button.	12	Make example for this keyboard (after setting up your build environment):
12		13
13	Depending on which keymap you would like to use, you will have to compile slightly differently.	14	make planck-rev4-default
14		15
15	### Default	16	See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. \ No newline at end of file
16	To build with the default keymap, simply run `make default`.
17
18	### Other Keymaps
19	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.
20
21	To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
22
23	```
24	$ make [default\|jack\|<name>]
25	```
26
27	Keymaps follow the format __\<name\>.c__ and are stored in the `keymaps` folder.
28
29	### Notable forks (which some of the keymap files are from)
30	- [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)
31	- [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c)
32	- [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck)
33	- [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid)


diff --git a/keyboards/preonic/readme.md b/keyboards/preonic/readme.md index 10763ee97..2a4ccd84d 100644 --- a/keyboards/preonic/readme.md +++ b/keyboards/preonic/readme.md
@@ -1,27 +1,16 @@
1	Preonic keyboard firmware	1	Preonic
2	======================	2	===
3	DIY/Assembled compact ortholinear 50% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
4		3
5	## Quantum MK Firmware	4	![Preonic](http://i.imgur.com/EDWQbB0.jpg)
6		5
7	For the full Quantum feature list, see [the parent readme.md](/readme.md).	6	A compact 50% (12x5) ortholinear keyboard kit made and sold by OLKB and Massdrop. [More info on qmk.fm](http://qmk.fm/preonic/)
8		7
9	## Building	8	Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert)
		9	Hardware Supported: Preonic PCB rev1, Teensy 2.0
		10	Hardware Availability: [OLKB.com](https://olkb.com/preonic/), [Massdrop](https://www.massdrop.com/buy/preonic-mechanical-keyboard?mode=guest_open)
10		11
11	Download or clone the whole firmware and navigate to the keyboards/preonic folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use `make dfu` to program your PCB once you hit the reset button.	12	Make example for this keyboard (after setting up your build environment):
12		13
13	Depending on which keymap you would like to use, you will have to compile slightly differently.	14	make preonic-default
14		15
15	### Default	16	See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. \ No newline at end of file
16	To build with the default keymap, simply run `make default`.
17
18	### Other Keymaps
19	Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap, create a file in the keymaps folder named `<name>.c` and see keymap document (you can find in top readme.md) and existent keymap files.
20
21	To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
22
23	```
24	$ make [default\|jack\|<name>]
25	```
26
27	Keymaps follow the format __\<name\>.c__ and are stored in the `keymaps` folder.