From 3e6c235e0bcdb1bb42a11ad23f5d6b4d7bf70476 Mon Sep 17 00:00:00 2001
From: AntoineVe <antoine@van-elstraete.net>
Date: Sun, 29 Nov 2020 22:39:08 +0100
Subject: [PATCH] HTML readme

---
 README.html | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.html

diff --git a/README.html b/README.html
new file mode 100644
index 0000000..965040a
--- /dev/null
+++ b/README.html
@@ -0,0 +1,40 @@
+<h1>PhotoReport</h1>
+<h2>Dépendences</h2>
+<ul>
+<li>Python 3</li>
+</ul>
+<h2>Installation</h2>
+<ul>
+<li>Créer un environnement virtuel python3 (e.g. : <code>virtulenv3 PhotoReport &amp;&amp; source bin/activate</code>)</li>
+<li>Cloner le dépôts (<code>git clone https://git.antoineve.me/PhotoReport/</code>)</li>
+<li>Installer les dépendances (Note : pour l'instant, version 0.1, ce n'est pas nécessaire)</li>
+</ul>
+<h2>Utilisation en ligne de commande</h2>
+<h3>exv.py</h3>
+<p>L'aide est disponible avec <code>./exv.py --help</code>.</p>
+<p>Exemple d'utilisation :</p>
+<pre><code>./exv.py -R -x jpg ~/Nextcloud/Photos/2019/
+</code></pre>
+<p>Exemple de sortie : <a href="https://git.antoineve.me/PhotoReport/tree/sortie_exemple.json">sortie_exemple.json</a></p>
+<h2>Comment contribuer ?</h2>
+<ul>
+<li>Cloner le dépôt : <code>git clone https://git.antoineve.me/PhotoReport/</code></li>
+<li>Créer une branche : <code>git checkout -b &lt;new_feature&gt;</code></li>
+<li>Coder et commiter : <code>git commit -a -m &lt;description&gt;</code></li>
+<li>Créer le patch : <code>git format-patch $(git merge-base --fork-point master)..&lt;new_feature&gt;</code></li>
+<li>M'envoyer le patch par mail : <a href="mailto:antoine+photoreport@van-elstraete.net">antoine+photoreport@van-elstraete.net</a></li>
+<li>J'applique le patch avec <code>git am --signoff -k &lt; &lt;new_feature&gt;.patch</code></li>
+</ul>
+<h2>BUGS &amp; TODO</h2>
+<ul>
+<li>Pour le moment, pas de sortie en PDF</li>
+<li>La base de donnée de darktable a changé depuis la première écriture du script</li>
+<li>La vitesse d'obturation n'est pas arrondie, est-ce souhaitable ? (16.666 ≠ 16.666666666666668 ?)</li>
+</ul>
+<h2>Features requests et développement prévu</h2>
+<ul>
+<li>Créer une option pour filtrer par objectif <strong>-&gt; branche filters/lens</strong></li>
+<li>Créer une option pour filtrer par boitier <strong>-&gt; branche filters/camera</strong></li>
+<li>Sortie PDF fonctionnelle <strong>-&gt; branche output/pdf_via_md</strong></li>
+<li>Créer une option pour une sortie exploitable par LaTeX</li>
+</ul>