1 files changed, 49 insertions, 0 deletions
diff --git a/readme.rst b/readme.rst
new file mode 100644
index 0000000..404e2f4
--- /dev/null
+++ b/readme.rst
@@ -0,0 +1,49 @@
+.. -*- mode: rst -*-
+.. -*-  coding: utf-8 -*-
+
+Ce projet contient le client pour le macropad dynamique.
+
+Installation
+============
+
+Préparation de la carte
+-----------------------
+
+Récupérer le firmware circuitpython sur la page adapté à la carte :
+
+https://circuitpython.org/board/0xcb_helios/
+
+Démarrer la carte en mode bootloader, et copier le fichier uf2 sur la
+partition.
+
+Installer les librairies
+------------------------
+
+Récupérer le bundle correspondant à la version du firmware :
+
+https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/tag/20240326
+
+Dans le répertoire `lib`, copier les dossiers :
+
+- adafruit_display_text
+- adafruit_displayio_ssd1306.mpy
+
+Télécharger la dernière version de KMK
+
+Dans le répertoire `lib`, copier le répertoire `KMK`.
+
+Installer l’application
+-----------------------
+
+Copier les fichiers présents dans le répertoire à la racine.
+
+Utilisation
+===========
+
+Démarrage
+---------
+
+Par défaut, la carte ne s’active pas avec le mode stockage USB. Cela permet de
+ne pas créer de lecteur sur le système. Pour que la carte se déclare comme un
+point de stockage, il faut appuyer sur une touche (n’importe laquelle) durant
+le démarrage.