diff options
| -rw-r--r-- | keyboards/lets_split/readme.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/keyboards/lets_split/readme.md b/keyboards/lets_split/readme.md index 0ef7ff59d..300722a1b 100644 --- a/keyboards/lets_split/readme.md +++ b/keyboards/lets_split/readme.md | |||
| @@ -16,10 +16,10 @@ There is additional information there about flashing and adding RGB underglow. | |||
| 16 | 16 | ||
| 17 | ## First Time Setup | 17 | ## First Time Setup |
| 18 | 18 | ||
| 19 | 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: | 19 | 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: |
| 20 | 20 | ||
| 21 | ``` | 21 | ``` |
| 22 | $ make rev2-default | 22 | $ make lets_split-rev2-default |
| 23 | ``` | 23 | ``` |
| 24 | 24 | ||
| 25 | You will see a lot of output and if everything worked correctly you will see the built hex file: | 25 | You will see a lot of output and if everything worked correctly you will see the built hex file: |
| @@ -32,7 +32,7 @@ If you would like to use one of the alternative keymaps, or create your own, cop | |||
| 32 | 32 | ||
| 33 | 33 | ||
| 34 | ``` | 34 | ``` |
| 35 | $ make rev2-YOUR_KEYMAP_NAME | 35 | $ make lets_split-rev2-YOUR_KEYMAP_NAME |
| 36 | ``` | 36 | ``` |
| 37 | 37 | ||
| 38 | If everything worked correctly you will see a file: | 38 | If everything worked correctly you will see a file: |
| @@ -67,7 +67,7 @@ Required Hardware | |||
| 67 | Apart from diodes and key switches for the keyboard matrix in each half, you | 67 | Apart from diodes and key switches for the keyboard matrix in each half, you |
| 68 | will need: | 68 | will need: |
| 69 | 69 | ||
| 70 | * 2 Arduino Pro Micro's. You can find theses on aliexpress for ≈3.50USD each. | 70 | * 2 Arduino Pro Micros. You can find these on AliExpress for ≈3.50USD each. |
| 71 | * 2 TRRS sockets and 1 TRRS cable, or 2 TRS sockets and 1 TRS cable | 71 | * 2 TRRS sockets and 1 TRRS cable, or 2 TRS sockets and 1 TRS cable |
| 72 | 72 | ||
| 73 | Alternatively, you can use any sort of cable and socket that has at least 3 | 73 | Alternatively, you can use any sort of cable and socket that has at least 3 |
| @@ -85,7 +85,7 @@ Wiring | |||
| 85 | The 3 wires of the TRS/TRRS cable need to connect GND, VCC, and digital pin 3 (i.e. | 85 | The 3 wires of the TRS/TRRS cable need to connect GND, VCC, and digital pin 3 (i.e. |
| 86 | PD0 on the ATmega32u4) between the two Pro Micros. | 86 | PD0 on the ATmega32u4) between the two Pro Micros. |
| 87 | 87 | ||
| 88 | Then wire your key matrix to any of the remaining 17 IO pins of the pro micro | 88 | Next, wire your key matrix to any of the remaining 17 IO pins of the pro micro |
| 89 | and modify the `matrix.c` accordingly. | 89 | and modify the `matrix.c` accordingly. |
| 90 | 90 | ||
| 91 | The wiring for serial: | 91 | The wiring for serial: |
| @@ -107,25 +107,25 @@ Notes on Software Configuration | |||
| 107 | 107 | ||
| 108 | Configuring the firmware is similar to any other QMK project. One thing | 108 | Configuring the firmware is similar to any other QMK project. One thing |
| 109 | to note is that `MATRIX_ROWS` in `config.h` is the total number of rows between | 109 | to note is that `MATRIX_ROWS` in `config.h` is the total number of rows between |
| 110 | the two halves, i.e. if your split keyboard has 4 rows in each half, then | 110 | the two halves, i.e. if your split keyboard has 4 rows in each half, then use |
| 111 | `MATRIX_ROWS=8`. | 111 | `MATRIX_ROWS=8`. |
| 112 | 112 | ||
| 113 | Also the current implementation assumes a maximum of 8 columns, but it would | 113 | Also, the current implementation assumes a maximum of 8 columns, but it would |
| 114 | not be very difficult to adapt it to support more if required. | 114 | not be very difficult to adapt it to support more if required. |
| 115 | 115 | ||
| 116 | Flashing | 116 | Flashing |
| 117 | ------- | 117 | ------- |
| 118 | From the `lets_split` directory run `make SUBPROJECT-KEYMAP-avrdude` for automatic serial port resolution and flashing. | 118 | From the top level `qmk_firmware` directory run `make KEYBOARD-SUBPROJECT-KEYMAP-avrdude` for automatic serial port resolution and flashing. |
| 119 | Example: `make rev2-default-avrdude` | 119 | Example: `make lets_split-rev2-default-avrdude` |
| 120 | 120 | ||
| 121 | 121 | ||
| 122 | Choosing which board to plug the USB cable into (choosing Master) | 122 | Choosing which board to plug the USB cable into (choosing Master) |
| 123 | -------- | 123 | -------- |
| 124 | Because the two boards are identical, the firmware has logic to differentiate the left and right board. | 124 | Because the two boards are identical, the firmware has logic to differentiate the left and right board. |
| 125 | 125 | ||
| 126 | It uses two strategies to figure things out: look at the EEPROM (memory on the chip) or looks if the current board has the usb cable. | 126 | It uses two strategies to figure things out: looking at the EEPROM (memory on the chip) or looking if the current board has the usb cable. |
| 127 | 127 | ||
| 128 | The EEPROM approach requires additional setup (flashing the eeeprom) but allows you to swap the usb cable to either side. | 128 | The EEPROM approach requires additional setup (flashing the eeprom) but allows you to swap the usb cable to either side. |
| 129 | 129 | ||
| 130 | 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. | 130 | 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. |
| 131 | 131 | ||