aboutsummaryrefslogtreecommitdiff
path: root/readme.rst
diff options
context:
space:
mode:
Diffstat (limited to 'readme.rst')
-rwxr-xr-xreadme.rst92
1 files changed, 91 insertions, 1 deletions
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`