mirrors/opensteno_qmk
1
0
Fork 0
mirror of https://github.com/openstenoproject/qmk synced 2024-11-12 11:34:38 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update Let's Split readme

Browse source 
Updated Let's Split readme to reflect `make` changes in #1659, removed incorrectly used apostrophe and other spelling / grammar errors
This commit is contained in:
Dylan Khor 2017-10-02 23:47:54 -04:00 committed by Jack Humbert
parent c206650ed0
commit e0834cfda9
1 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
keyboards/lets_split/readme.md
View file

@ -16,10 +16,10 @@ There is additional information there about flashing and adding RGB underglow.
## First Time Setup ## 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: 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 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: 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
``` ```
$ make rev2-YOUR_KEYMAP_NAME $ make lets_split-rev2-YOUR_KEYMAP_NAME
``` ```
If everything worked correctly you will see a file: If everything worked correctly you will see a file:
@ -67,7 +67,7 @@ Required Hardware
Apart from diodes and key switches for the keyboard matrix in each half, you Apart from diodes and key switches for the keyboard matrix in each half, you
will need: will need:
* 2 Arduino Pro Micro's. You can find theses on aliexpress for ≈3.50USD each. * 2 Arduino Pro Micros. You can find these on AliExpress for ≈3.50USD each.
* 2 TRRS sockets and 1 TRRS cable, or 2 TRS sockets and 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 Alternatively, you can use any sort of cable and socket that has at least 3
@ -85,7 +85,7 @@ Wiring
The 3 wires of the TRS/TRRS 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. 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 Next, wire your key matrix to any of the remaining 17 IO pins of the pro micro
and modify the `matrix.c` accordingly. and modify the `matrix.c` accordingly.
The wiring for serial: The wiring for serial:
@ -107,25 +107,25 @@ Notes on Software Configuration
Configuring the firmware is similar to any other QMK project. One thing Configuring the firmware is similar to any other QMK project. One thing
to note is that `MATRIX_ROWS` in `config.h` is the total number of rows between to note is that `MATRIX_ROWS` in `config.h` is the total number of rows between
the two halves, i.e. if your split keyboard has 4 rows in each half, then the two halves, i.e. if your split keyboard has 4 rows in each half, then use
`MATRIX_ROWS=8`. `MATRIX_ROWS=8`.
Also the current implementation assumes a maximum of 8 columns, but it would Also, the current implementation assumes a maximum of 8 columns, but it would
not be very difficult to adapt it to support more if required. not be very difficult to adapt it to support more if required.
Flashing Flashing
------- -------
From the `lets_split` directory run `make SUBPROJECT-KEYMAP-avrdude` for automatic serial port resolution and flashing. From the top level `qmk_firmware` directory run `make KEYBOARD-SUBPROJECT-KEYMAP-avrdude` for automatic serial port resolution and flashing.
Example: `make rev2-default-avrdude` Example: `make lets_split-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)
-------- --------
Because the two boards are identical, the firmware has logic to differentiate the left and right board. Because the two boards are identical, the firmware has logic to differentiate the left and right board.
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. 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.
The EEPROM approach requires additional setup (flashing the eeeprom) but allows you to swap the usb cable to either side. The EEPROM approach requires additional setup (flashing the eeprom) but allows you to swap the usb cable to either side.
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. 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.