X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=keyboards%2Flets_split%2Freadme.md;h=7e5a5460223c5108fa2cad30923445e4d3e7a9c6;hb=fbd9d04559962cb0db3a584d397f49371a4d7fb6;hp=0e903065e227e03f73a2fd9900865ca7891b2d30;hpb=048ef311dc5a92d736c8b0778334bfa82f8f42a8;p=qmk_firmware.git diff --git a/keyboards/lets_split/readme.md b/keyboards/lets_split/readme.md index 0e903065e..7e5a54602 100644 --- a/keyboards/lets_split/readme.md +++ b/keyboards/lets_split/readme.md @@ -7,6 +7,12 @@ Split keyboard firmware for Arduino Pro Micro or other ATmega32u4 based boards. +## Build Guide + +A build guide for putting together the Let's Split v2 can be found here: [An Overly Verbose Guide to Building a Let's Split Keyboard](https://github.com/nicinabox/lets-split-guide) + +There is additional information there about flashing and adding RGB underglow. + ## First Time Setup Download or clone the whole firmware and navigate to the keyboards/lets_split directory. Once your dev env is setup, you'll be able to generate the default .hex using: @@ -62,8 +68,7 @@ Apart from diodes and key switches for the keyboard matrix in each half, you will need: * 2 Arduino Pro Micro's. You can find theses on aliexpress for ≈3.50USD each. -* 2 TRS sockets -* 1 TRS cable. +* 2 TRRS sockets and 1 TRRS cable, or 2 TRS sockets and 1 TRS cable Alternatively, you can use any sort of cable and socket that has at least 3 wires. If you want to use I2C to communicate between halves, you will need a @@ -77,7 +82,7 @@ A speaker can be hooked-up to either side to the `5` (`C6`) pin and `GND`, and t Wiring ------ -The 3 wires of the TRS cable need to connect GND, VCC, and digital pin 3 (i.e. +The 3 wires of the TRS/TRRS cable need to connect GND, VCC, and digital pin 3 (i.e. PD0 on the ATmega32u4) between the two Pro Micros. Then wire your key matrix to any of the remaining 17 IO pins of the pro micro @@ -123,12 +128,12 @@ The EEPROM approach requires additional setup (flashing the eeeprom) but allows The USB cable approach is easier to setup and if you just want the usb cable on the left board, you do not need to do anything extra. ### Setting the left hand as master -If you always plug the usb cable into the left board, nothing extra is needed as this is the default. Comment out `EE_HANDS` and comment out `I2C_MASTER_RIGHT` if for some reason it was set. +If you always plug the usb cable into the left board, nothing extra is needed as this is the default. Comment out `EE_HANDS` and comment out `I2C_MASTER_RIGHT` or `MASTER_RIGHT` if for some reason it was set. ### Setting the right hand as master If you always plug the usb cable into the right board, add an extra flag to your `config.h` ``` - #define I2C_MASTER_RIGHT + #define MASTER_RIGHT ``` ### Setting EE_hands to use either hands as master