gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2025-07-16 04:41:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README for Lrrr

Browse Source
This commit is contained in:
leviport 2020-02-24 15:45:17 -07:00
parent 780c951b36
commit 24d9d0f00e
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
keyboards/system76/lrrr/README.md
View File

@ -3,14 +3,12 @@
* After cloning, you probably need to run `make git-submodule`. * After cloning, you probably need to run `make git-submodule`.
- You may also need to install dependencies: `sudo apt install avrdude gcc-avr avr-libc` - You may also need to install dependencies: `sudo apt install avrdude gcc-avr avr-libc`
* To build the firmware without flashing the keyboard, use `make (keyboard name):(layout name)` * To build the firmware without flashing the keyboard, use `make (keyboard name):(layout name)`
- For example, if I want to build Levi's layout for the uglydense keyboard, I will run: - For example, if I want to build Levi's layout for the lrrr keyboard, I will run:
`make system76/uglydense:levi` `make system76/lrrr:levi`
* Before flashing firmware, disable your ModemManager: `systemctl stop ModemManager.service`
- It messes with the flasher, so just stop it before flashing. You can disable it with `systemctl disable ModemManager.service` if you wish to.
* To flash the firmware, you'll use the same build command, but with `flash` added to the end: * To flash the firmware, you'll use the same build command, but with `flash` added to the end:
`make system76/uglydense:default:flash` `make system76/lrrr:default:flash`
- After it builds, you will see a message that says `Detecting USB port, reset your controller now...`. You then want to hit the "RESET" key on the keyboard if it is programmed into the layout. - After it builds, you will see a message that says `Detecting USB port, reset your controller now...`. You then want to hit the "RESET" key on the keyboard if it is programmed into the layout.
- In the default layout and the `levi` layout, it is Fn+Esc. If a RESET key is not programmed into the layout, unplugging and re-plugging the keyboard sometimes begins the flashing process. If it doesn't, you'll have to briefly bridge the RST and GND pins on the Arduino Pro Micro inside the keyboard. Don't attempt this unless you know what you are doing. - In the default layout, it is Fn+Esc. If a RESET key is not programmed into the layout, you will have to push the button on the Arduino Micro controller board.
## Making your own layout: ## Making your own layout:
If you want to create your own layout, go to the `keymaps` directory and copy one of the maps in there. You'll probably want to start with the default layout, but the other layouts in there may be helpful references. The name of the directory you create will be the name of your layout. Ensure that it has no spaces or strange symbols, as this could lead to build errors. If you want to create your own layout, go to the `keymaps` directory and copy one of the maps in there. You'll probably want to start with the default layout, but the other layouts in there may be helpful references. The name of the directory you create will be the name of your layout. Ensure that it has no spaces or strange symbols, as this could lead to build errors.