]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - keyboards/lets_split/readme.md
Document the correct path to the split keyboard EEPROM files (#4585)
[qmk_firmware.git] / keyboards / lets_split / readme.md
index 300722a1bb330399b2ae2d342fb5069e24a5c7c6..2a2b95c0971de9419c8c89e3366f05c63fc42cc7 100644 (file)
@@ -7,6 +7,7 @@ Split keyboard firmware for Arduino Pro Micro or other ATmega32u4
 based boards.
 
 **Hardware files for the Let's Split are now stored at http://qmk.fm/lets_split/**
+**Hardware files for the sockets version can be found at https://github.com/dumle29/let-s-Split-v2/tree/socket-reverseable**
 
 ## Build Guide
 
@@ -14,12 +15,14 @@ A build guide for putting together the Let's Split v2 can be found here: [An Ove
 
 There is additional information there about flashing and adding RGB underglow.
 
+A build guide for putting together the sockets version can be found here: *Guide will be made and linked here when the PCBs have been received and tested*
+
 ## First Time Setup
 
 Download or clone the `qmk_firmware` repo and navigate to its top level directory. Once your build environment is setup, you'll be able to generate the default .hex using:
 
 ```
-$ make lets_split-rev2-default
+$ make lets_split/rev2:default
 ```
 
 You will see a lot of output and if everything worked correctly you will see the built hex file:
@@ -32,7 +35,7 @@ If you would like to use one of the alternative keymaps, or create your own, cop
 
 
 ```
-$ make lets_split-rev2-YOUR_KEYMAP_NAME
+$ make lets_split/rev2:YOUR_KEYMAP_NAME
 ```
 
 If everything worked correctly you will see a file:
@@ -41,7 +44,7 @@ If everything worked correctly you will see a file:
 lets_split_rev2_YOUR_KEYMAP_NAME.hex
 ```
 
-For more information on customizing keymaps, take a look at the primary documentation for [Customizing Your Keymap](/readme.md##customizing-your-keymap) in the main readme.md.
+For more information on customizing keymaps, take a look at the primary documentation for [Customizing Your Keymap](/docs/faq_keymap.md) in the main readme.md.
 
 ### Let's split 1.0
 If you have a first generation Let's Split you will need to use the revision 1 code. To do so, use `rev1` in all your commands instead.
@@ -115,8 +118,8 @@ not be very difficult to adapt it to support more if required.
 
 Flashing
 -------
-From the top level `qmk_firmware` directory run `make KEYBOARD-SUBPROJECT-KEYMAP-avrdude` for automatic serial port resolution and flashing.
-Example: `make lets_split-rev2-default-avrdude`
+From the top level `qmk_firmware` directory run `make KEYBOARD:KEYMAP:avrdude` for automatic serial port resolution and flashing.
+Example: `make lets_split/rev2:default:avrdude`
 
 
 Choosing which board to plug the USB cable into (choosing Master)
@@ -148,13 +151,13 @@ file will run on both hands instead of having to flash left and right 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
+avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:"./quantum/split_common/eeprom-lefthand.eep"
 // or the equivalent in dfu-programmer
 
 ```
 and similarly for right half
 ```
-avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-righhand.eep
+avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:"./quantum/split_common/eeprom-righthand.eep"
 // or the equivalent in dfu-programmer
 ```