docs(readme): create readme
This commit is contained in:
12
readme.md
Normal file
12
readme.md
Normal 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.
|
Reference in New Issue
Block a user