README.txt qui explique le fonctionnement de l'éditeur

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..4bffdce
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,45 @@
+Dépendances:
+       OCaml
+       ocaml-graphics
+
+Compiler:
+       dune b
+(Compiler et) Exécuter:
+       dune exec cells
+
+Ceci est un éditeur modal et simulateur d'automates cellulaires.
+Pour l'utiliser, il faut donc connaitre les commandes des différents
+modes.
+
+L'éditeur démarre en mode normal. Les commandes sont les suivantes:
+       : -> passer en mode commande
+       0 -> revenir aux coordonnées 0:0
+       s -> mets la case pointée à la valeur actuelle
+       q, d -> mets la valeur actuelle à la précédente, ou la suivante
+       f -> effectue une étape de simulation
+       h, j, k, l -> se déplace d'une case à gauche, en bas, en haut,
+               ou à droite.
+       i, o -> zoome, ou dézoome
+
+Toute commande (sauf s, :, et 0) peut être précédée d'un nombre (en
+décimal, ne commençant pas par 0) qui indique le nombre de fois que l'on
+souhaite l'exécuter.
+
+En mode commande, que l'on active en faisant :, on peut taper des
+commandes plus longues, avec autocomplétion. Attention, les commandes
+ne demandent pas confirmation avec de s'effectuer sans sauvegarder.
+       quit -> Quitte l'éditeur.
+       clear -> Efface tout le contenu de la grille.
+       select <auto> -> Change l'automate actuel à celui nommé <auto>.
+       write <fichier> -> Sauvegarde l'état actuel de la grille dans
+               <fichier>.
+       read <fichier> -> Lis le nouvel état de la grille depuis
+               <fichier>. Change l'automate actuel si besoin.
+On peut effacer le dernier caractère via la touche retour arrière.
+On peut repasser en mode normal with la touche échap.
+On peut exécuter la commande en faisant entrée.
+On peut activer l'autocomplétion en faisant une tabulation.
+Toutes les autres touches servent simplement à écrire la commande.
+
+J'accepterai avec plaisir les contributions utiles envoyées par mail
+(via git send-mail) à mon adresse personelle (indiquée sur mon site).