From 2ccb8d45ce937a8776864326bd712dc16cc16ad9 Mon Sep 17 00:00:00 2001
From: Fabrice Mouhartem <fabrice.mouhartem@ens-lyon.org>
Date: Sun, 27 Jul 2025 14:43:43 +0200
Subject: [PATCH] docs(readme): create readme

---
 readme.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 readme.md

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.