From 02b663b21099cdb62cef7b363cae46a56d7aae5f Mon Sep 17 00:00:00 2001
From: Sébastien Dailly <sebastien@chimrod.com>
Date: Mon, 30 Nov 2020 16:26:27 +0100
Subject: Update readme

---
 readme.rst           |  92 ++++++++++++++++++++++++++++++++++++++++++++++++++-
 snapshots/model1.png | Bin 0 -> 173264 bytes
 snapshots/model2.png | Bin 0 -> 158086 bytes
 snapshots/model3.png | Bin 0 -> 139147 bytes
 4 files changed, 91 insertions(+), 1 deletion(-)
 create mode 100644 snapshots/model1.png
 create mode 100644 snapshots/model2.png
 create mode 100644 snapshots/model3.png

diff --git a/readme.rst b/readme.rst
index b3ca08c..fa42f43 100755
--- a/readme.rst
+++ b/readme.rst
@@ -1,3 +1,93 @@
+.. default-role:: literal
+
 Différents modèles avec rst & latex
 
-Chaque répertoire contient un style de document
+Clone et installation
+=====================
+
+.. code-block:: bash
+
+  git clone http://git.chimrod.com/latex_template.git/
+
+
+Pré-requis
+----------
+
+La compilation des fichiers en PDF requiert python et docutils. Il faut bien
+sûr latex pour générer le pdf.
+
+Organisation
+============
+
+Chaque répertoire contient un style de document. La commande `make` permet de
+générer le fichier PDF à partir du fichier source.
+
+Les images ci-dessous sont construites à partir des fichiers exemples :
+
+Model 1
+-------
+
+.. image:: /latex_template.git/plain/snapshots/model1.png
+  :width: 400px
+
+`[Version PDF]`__
+
+.. __: /latex_template.git/plain/model_1/example.pdf
+
+
+Model 2
+-------
+
+.. image:: /latex_template.git/plain/snapshots/model2.png
+  :width: 400px
+
+`[Version PDF]`__
+
+.. __: /latex_template.git/plain/model_2/example.pdf
+
+Model 3
+-------
+
+.. image:: /latex_template.git/plain/snapshots/model3.png
+  :width: 400px
+
+`[Version PDF]`__
+
+.. __: /latex_template.git/plain/model_3/example.pdf
+
+La syntaxe
+==========
+
+La colonne latérale
+-------------------
+
+Le code suivant permet de créer une section dans la colonne :
+
+
+.. code-block:: rst
+
+  .. sidebar:: Informations
+
+    * 17 allée des cerisiers
+    * 75001 Paris
+    * 01 23 45 67 89
+    * email@example
+    * 01/02/1980
+    * Permis B
+
+
+Les graphiques
+--------------
+
+La ligne suivante introduit les étoiles colorées en fonction du niveau (jusque
+5)
+
+.. code-block:: rst
+
+  :star:`4.5`
+
+La commande `level` l'affiche sous la forme d'une petite barre :
+
+.. code-block:: rst
+
+  :level:`3`
diff --git a/snapshots/model1.png b/snapshots/model1.png
new file mode 100644
index 0000000..3e2a805
Binary files /dev/null and b/snapshots/model1.png differ
diff --git a/snapshots/model2.png b/snapshots/model2.png
new file mode 100644
index 0000000..48fdde4
Binary files /dev/null and b/snapshots/model2.png differ
diff --git a/snapshots/model3.png b/snapshots/model3.png
new file mode 100644
index 0000000..f9c55b7
Binary files /dev/null and b/snapshots/model3.png differ
-- 
cgit v1.2.3