qmk_firmware

mirror of https://github.com/qmk/qmk_firmware.git synced 2025-03-13 15:04:11 +00:00

History

Jeremy Soller 9c24c1a932 Fix issues with compiling board and version commands		2020-09-30 10:23:53 -06:00
..
keymaps/default	Enable dynamic keymap	2020-09-29 10:54:24 -06:00
config.h	Enable dynamic keymap	2020-09-29 10:54:24 -06:00
launch_test.c	Fix issues with compiling board and version commands	2020-09-30 10:23:53 -06:00
launch_test.h	Enable dynamic keymap	2020-09-29 10:54:24 -06:00
README.md	Add launch testboard	2020-08-28 20:54:15 -06:00
rules.mk	Enable dynamic keymap	2020-09-29 10:54:24 -06:00

README.md

Flashing firmware:

Clone this repository and cd into the qmk_firmware directory.
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
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 Launch keyboard, I will run: make system76/launch:levi
To flash the firmware, you'll use the same build command, but with flash added to the end: make system76/launch: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.
- In the default layout, it is Fn+Esc. If a RESET key is not programmed into the layout, you will have to manually reset the controller.

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.

Inside of each layout directory, there is a file called keymap.c, which is what you will be customizing to create your own keymap. The commented out grid area in this file is a reference for the actual key assignments below it. When I am modifying a layout, I first update this grid. It helps me keep track of where I want everything. It does not matter what you label the keys in this grid since it is in a comment. Just try to keep it understandable for yourself and everyone else.

The keycodes below that do have to be typed correctly. A full list of keycodes can be found here: https://beta.docs.qmk.fm/reference/keycodes . Use the shorter keycode alias to help keep these lined up (e.g. use KC_ESC instead of KC_ESCAPE).