diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..e43f454 --- /dev/null +++ b/readme.md @@ -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.