]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - keyboards/orthodox/readme.md
Document the correct path to the split keyboard EEPROM files (#4585)
[qmk_firmware.git] / keyboards / orthodox / readme.md
index 94bb8ebb97ed4b3fa4b17ce766ba4b27d4fc88f0..8bf60a9bdda2ce05a85b6405787927a68b03ee66 100644 (file)
@@ -34,23 +34,23 @@ For further reading on build- and flashing-procedures for split ortholinear skel
 
 ## 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
+$ 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:
 
 ```
-orthodox_rev1_serial.hex
+orthodox_rev1_default.hex
 ```
 
 If you would like to use one of the alternative keymaps, or create your own, copy one of the existing [keymaps](keymaps/) and run make like so:
 
 
 ```
-$ make rev1-YOUR_KEYMAP_NAME
+$ make orthodox/rev1:YOUR_KEYMAP_NAME
 ```
 
 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
 -------
-From the keymap directory run `make SUBPROJECT-KEYMAP-avrdude` for automatic serial port resolution and flashing.
-Example: `make rev2-serial-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)
@@ -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
-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](../../quantum/split_common/eeprom-lefthand.eep) and [right](../../quantum/split_common/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
-
 ```
 and similarly for right half
 ```