docs(readme): create readme

This commit is contained in:
2025-07-27 14:43:43 +02:00
parent 27cb5b8d48
commit 2ccb8d45ce

12
readme.md Normal file
View File

@@ -0,0 +1,12 @@
# Keymap image generation
## Prerequisites
- `uv` to manage python package
- `make`
## How to generate images
`make` will locally install
[`keymap-drawer`](https://github.com/caksoylar/keymap-drawer)
in `.venv` using `uv` and compile the different keymaps.