Kinesis refactor and Configurator update (#3245)

[qmk_firmware.git] / keyboards / kinesis / stapelberg / readme.md

diff --git a/keyboards/kinesis/stapelberg/readme.md b/keyboards/kinesis/stapelberg/readme.md
index b04a0bd49c8abe31e1ff5cb2baad9bf544029751..37b26623f238fed092cd8de42ba8cf2f545bd2b0 100644 (file)
--- a/keyboards/kinesis/stapelberg/readme.md
+++ b/keyboards/kinesis/stapelberg/readme.md
@@ -1,7 +1,7 @@
 # kinesis_stapelberg keyboard firmware
 
 This folder contains the firmware customization required to run QMK on the custom controller for the Kinesis Advantage created by Michael Stapelberg.
 # kinesis_stapelberg keyboard firmware
 
 This folder contains the firmware customization required to run QMK on the custom controller for the Kinesis Advantage created by Michael Stapelberg.

-It differs from the `alvicstep keyboard in that the existing QMK Kinesis Advantage project uses the existing controller board provided by Kinesis.
+It differs from the `alvicstep` keyboard in that the existing QMK Kinesis Advantage project uses the existing controller board provided by Kinesis.

 
 The controller board hardware is described
 [here](http://michael.stapelberg.de/Artikel/kinesis_custom_controller)
 
 The controller board hardware is described
 [here](http://michael.stapelberg.de/Artikel/kinesis_custom_controller)


@@ -26,30 +26,28 @@ If you want to perform this customization, these parts may be helpful.
 | Reset cables                                           | 2        | Sparkfun | PRT-09140    |
 
 The board and connections are shown here
 | Reset cables                                           | 2        | Sparkfun | PRT-09140    |
 
 The board and connections are shown here

-![](images/controller_board.jpg)
+![controller board](https://i.imgur.com/2ZPMwvZ.jpg)

 
 The Teensy mounting detail can be seen here.
 I used a socket for prototyping.
 
 The Teensy mounting detail can be seen here.
 I used a socket for prototyping.

-![](images/teensy_detail.jpg)
+![teensy detail](https://i.imgur.com/HrkGUjc.jpg)

 
 
 Since the proper mounting of the Teensy board places the reset button in a tight space, I added a 2-pin header to the reset and ground pins on the edge of the board.
 Shorting these two pins together will reset the board.
 I also put female to male header jumper cables on these so they could be accessed outside the enclosure.
 The exterior cables can be seen here.
 
 
 Since the proper mounting of the Teensy board places the reset button in a tight space, I added a 2-pin header to the reset and ground pins on the edge of the board.
 Shorting these two pins together will reset the board.
 I also put female to male header jumper cables on these so they could be accessed outside the enclosure.
 The exterior cables can be seen here.

-![](images/exterior_reset.jpg)
+![exterior reset](https://i.imgur.com/JNoxI40.jpg)

 
 
 ## Keymaps
 
 ### Default
 
 
 
 ## Keymaps
 
 ### Default
 

-To build with the default keymap, run `make default` while in the
-`kinesis_stapelberg` working directory.
+To build with the default keymap, run `make kinesis/stapelberg` while in the QMK directory.

 
 ### Dvorak
 
 This keymap contains a dvorak implementation as well as media and symbol layers.
 
 
 ### Dvorak
 
 This keymap contains a dvorak implementation as well as media and symbol layers.
 

-Run `make dvorak` while in the `kinesis_stapelberg` working directory.
-
+Run `make kinesis/stapelberg:dvorak` while in the QMK directory.