From ca09e86987f77b41ddc228bf26dff6d73d48b00c Mon Sep 17 00:00:00 2001 From: Jeremy Soller Date: Fri, 4 Jun 2021 06:55:48 -0600 Subject: [PATCH] Update documentation --- doc/keyboard-layout-customization.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/doc/keyboard-layout-customization.md b/doc/keyboard-layout-customization.md index 4b1936d..9117b47 100644 --- a/doc/keyboard-layout-customization.md +++ b/doc/keyboard-layout-customization.md @@ -12,13 +12,20 @@ currently using. something like "2020-09-17_f10af76". * Clone the [system76/firmware-open](https://github.com/system76/firmware-open) repository. -* Checkout the version that matches your firmware, e.g.: `git checkout f10af76`. +* Checkout the version that matches your firmware, e.g.: + `git checkout f10af76`. * Run `git submodule init && git submodule update && cd ec`. +* This documentation is subject to change, please use the version in the + repository you just cloned. ## Adding your layout -* In `src/board/system76/{your-model}/keymap/`, copy `default.c` and rename it. - There are two examples to reference in the `lemp9` directory: `jeremy.c` and - `levi.c`. +* In `src/board/system76/{your-model}/board.mk`, locate the line starting with + `KEYBOARD=`. The value after the equal sign is your keyboard type, the most + common is `15in_102`. We will use the `lemp9` keyboard as an example, which + is `14in_83` +* In `src/board/keyboard/{keyboard-type}/keymap/`, copy `default.c` and rename + it. There are two examples to reference in the `14in_83` directory: + `jeremy.c` and `levi.c`. * In `src/common/include/common/keymap.h` you will find a list of the key definitions. * You will notice two sets of keys in these layout files. The top one is the @@ -26,15 +33,15 @@ currently using. the Fn key is being held. If you look at the Fn layer in the `levi.c` layout, you will see that there are arrow keys at WASD, media and volume keys on the bottom row, etc. -* Hint: To avoid losing your place change one key at a time, referencing the key - code you are deleting to keep yourself positioned correctly in the list of - keycodes. +* Hint: To avoid losing your place change one key at a time, referencing the + key code you are deleting to keep yourself positioned correctly in the list + of keycodes. ## Configure your EC to build with your layout * Create a file in the project's root directory called `config.mk` and add your board and keyboard layout to it. For example, if you want to build lemp9 firmware with Jeremy's layout (which is at - `ec/src/board/system76/lemp9/keymap/jeremy.c`): + `ec/src/keyboard/14in_83/keymap/jeremy.c`): ``` BOARD?=system76/lemp9 KEYMAP?=jeremy