Skip to content

Commit

Permalink
Link to ZMK Locales module
Browse files Browse the repository at this point in the history
  • Loading branch information
joelspadin committed Sep 15, 2024
1 parent d6c96c3 commit cc85045
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,15 @@ This Python module generates localized keyboard layout headers for [ZMK](https:/

Python 3.10 or newer is required.

## Using Generated Headers
## Usage

### Using a module

Add the [ZMK Locales module](https://github.com/joelspadin/zmk-locales) to your build to make all the generated headers available. See the documentation in that repo for more details.

### Using generated headers directly

If you do not want to use a module, or if you want to generate your own headers to use, then you can copy the header files directly into your config repo.

First, determine what keyboard layout your OS is set to, then [download the matching header from the latest release](https://github.com/joelspadin/zmk-locale-generator/releases) or follow [Generating Headers](#generating-headers) to build the header yourself. Place the header in your ZMK config repo's `config/` directory alongside your `.keymap` file.

Expand Down

0 comments on commit cc85045

Please sign in to comment.