Do some cleanup for the API

[qmk_firmware.git] / keyboards / orthodox / readme.md

diff --git a/keyboards/orthodox/readme.md b/keyboards/orthodox/readme.md
index 57e940b0f43db3f6bbe0e550882565469202aa8e..0c47dd9c439ee0951f351e90c698b10b4ef1d023 100644 (file)
--- a/keyboards/orthodox/readme.md
+++ b/keyboards/orthodox/readme.md
@@ -34,10 +34,10 @@ For further reading on build- and flashing-procedures for split ortholinear skel
 
 ## First Time Setup
 
 
 ## First Time Setup
 

-Download or clone the whole firmware and navigate to the keyboards/orthodox directory. Once your dev env is setup, you'll be able to generate the default .hex using:
+Download or clone the whole firmware and navigate to the root directory. Once your dev env is setup, you'll be able to generate the default .hex using:

 
 ```
 
 ```

-$ make rev1-default
+$ make orthodox/rev1:default

 ```
 
 You will see a lot of output and if everything worked correctly you will see the built hex files in your *root qmk_firmware directory* two levels up:
 ```
 
 You will see a lot of output and if everything worked correctly you will see the built hex files in your *root qmk_firmware directory* two levels up:


@@ -50,7 +50,7 @@ If you would like to use one of the alternative keymaps, or create your own, cop
 
 
 ```
 
 
 ```

-$ make rev1-YOUR_KEYMAP_NAME
+$ make orthodox/rev1:YOUR_KEYMAP_NAME

 ```
 
 If everything worked correctly you will see a file:
 ```
 
 If everything worked correctly you will see a file:


@@ -96,8 +96,8 @@ the two halves, i.e. if your split keyboard has 3 rows in each half, then
 
 Flashing
 -------
 
 Flashing
 -------

-From the keymap directory run `make SUBPROJECT-KEYMAP-avrdude` for automatic serial port resolution and flashing.
-Example: `make rev2-default-avrdude`
+From the root directory run `make PROJECT:KEYMAP:avrdude` for automatic serial port resolution and flashing.
+Example: `make orthodox/rev2:default:avrdude`

 
 
 Choosing which board to plug the USB cable into (choosing Master)
 
 
 Choosing which board to plug the USB cable into (choosing Master)


@@ -125,13 +125,12 @@ EEPROM for the left and right halves.
 
 The EEPROM is used to store whether the
 half is left handed or right handed. This makes it so that the same firmware
 
 The EEPROM is used to store whether the
 half is left handed or right handed. This makes it so that the same firmware

-file will run on both hands instead of having to flash left and right handed
+file will run on both hands instead of having to flash [left](../lets_split/eeprom-lefthand.eep) and [right](../lets_split/eeprom-righthand.eep) handed

 versions of the firmware to each half. To flash the EEPROM file for the left
 half run:
 ```
 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep
 // or the equivalent in dfu-programmer
 versions of the firmware to each half. To flash the EEPROM file for the left
 half run:
 ```
 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep
 // or the equivalent in dfu-programmer

-

 ```
 and similarly for right half
 ```
 ```
 and similarly for right half
 ```