Update index.html

index.html

@@ -1 +1,57 @@
-HELLO
+<h1 id="pr-sentateur">Présentateur</h1>
+<p>Présentateur est un bot Discord qui génère des présentations complètes sur un sujet donné grâce à GPT-3 d&#39;OpenAI.</p>
+<p><img src="https://raw.githubusercontent.com/Paillat-dev/presentator/main/examples/steve-jobs/Steve-Jobs-1.png" alt="Exemple de présentation"></p>
+<p><img src="https://raw.githubusercontent.com/Paillat-dev/presentator/main/examples/python/the-python-programming-language-1.png" alt="Exemple de présentation"></p>
+<h2 id="fonctionnement">Fonctionnement</h2>
+<ul>
+<li>Le bot envoie une demande à l&#39;API d&#39;OpenAI avec le sujet donné et des indications au format Markdown Marp.</li>
+<li>Nous extrayons les images du Markdown et les envoyons à l&#39;API de génération d&#39;images.</li>
+<li>Nous générons les fichiers PDF et HTML à partir du Markdown.</li>
+<li>Nous envoyons les fichiers PDF et HTML à l&#39;utilisateur.</li>
+</ul>
+<h2 id="installation">Installation</h2>
+<p><strong>IMPORTANT</strong> L&#39;installation pour Linux et MacOS n&#39;est pas encore documentée. Si vous souhaitez la compléter, n&#39;hésitez pas à faire une pull request.
+Pour suivre les étapes de cette installation, vous devrez ouvrir un terminal. POur ce faire, tapez cmd dans la barre de recherche de votre ordinateur, puis entrée.</p>
+<h3 id="pr-requis">Prérequis</h3>
+<ul>
+<li>Installez Python 3.8 <a href="https://www.python.org/downloads/">https://www.python.org/downloads/</a></li>
+<li>Un token pour un bot Discord <a href="https://www.writebots.com/discord-bot-token/">https://www.writebots.com/discord-bot-token/</a></li>
+<li>Une clé d&#39;API OpenAI <a href="https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key">https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key</a></li>
+<li>Un compte discord et un serveur discord où ajouter l&#39;outil.<ul>
+<li><a href="https://www.ionos.fr/digitalguide/serveur/know-how/creer-un-compte-discord">https://www.ionos.fr/digitalguide/serveur/know-how/creer-un-compte-discord</a></li>
+<li><a href="https://www.ionos.fr/digitalguide/serveur/know-how/creer-un-serveur-discord/">https://www.ionos.fr/digitalguide/serveur/know-how/creer-un-serveur-discord/</a></li>
+</ul>
+</li>
+<li><strong>Ne suivez pas l&#39;étape 5 et à l&#39;étape huit séléctionnez le permissions &quot;administrateur&quot;.</strong> Un bot discord <a href="https://www.ionos.fr/digitalguide/serveur/know-how/creer-un-bot-discord/#:~:text=help%C2%A0%C2%BB%20du%20bot.-,Cr%C3%A9ez%20votre%20propre%20bot%20Discord,-Si%20vous%20ne">https://www.ionos.fr/digitalguide/serveur/know-how/creer-un-bot-discord/#:~:text=help%C2%A0%C2%BB%20du%20bot.-,Cr%C3%A9ez%20votre%20propre%20bot%20Discord,-Si%20vous%20ne</a></li>
+</ul>
+<h3 id="installation">Installation</h3>
+<ul>
+<li>Télécharez le code ici: <a href="https://github.com/Paillat-dev/presentator/archive/refs/heads/main.zip">https://github.com/Paillat-dev/presentator/archive/refs/heads/main.zip</a></li>
+<li>Extrayez le dossier sur votre disque dur.</li>
+<li>Installez pip en tapant la commande suivante dans le terminal: <code>py -m ensurepip --upgrade</code></li>
+<li>Redémarrez votre ordinateur.</li>
+<li>Ouvrez un terminal DANS LE DOSSIER téléchargé à l&#39;étape 1. Pour ce faire, ouvrez le dossier éxtrait, tout en maintenant la touche Maj ⇧ enfoncée, faites un clic droit sur une zone vide et sélectionnez Ouvrir une fenêtre de commandes ici.</li>
+<li>Tapez la commande suivante dans le terminal:<pre><code>pip <span class="hljs-keyword">install</span> -r requirements.txt
+</code></pre></li>
+<li>Téléchargez le fichier Marp ici: <a href="https://github.com/marp-team/marp-cli/releases/download/v2.3.0/marp-cli-v2.3.0-win.zip">https://github.com/marp-team/marp-cli/releases/download/v2.3.0/marp-cli-v2.3.0-win.zip</a></li>
+<li>Extrayez le contenu du fichier téléchargé dans le dossier présentateur (celui que vous avez téléchargé et éxtrait à l&#39;étape 1).</li>
+<li>Redémarrez votre ordinateur.</li>
+<li>Mettez votre clé d&#39;API OpenAI et votre token de bot Discord dans le fichier <code>.env.example</code> et renommez-le en <code>.env</code>.</li>
+</ul>
+<h3 id="g-n-ration-d-images-optionnel-">Génération d&#39;images (optionnel)</h3>
+<ul>
+<li>Dans le fichier <code>.env</code>, définissez la variable <code>USE_IMAGES</code> sur <code>dalle</code>. Il devrait ensuite ressebler à ceci:<pre><code>TOKEN=<span class="hljs-strong">_____</span><span class="hljs-strong">_____</span><span class="hljs-strong">_____</span><span class="hljs-strong">_____</span><span class="hljs-strong">_____</span><span class="hljs-strong">_____</span><span class="hljs-strong">_____</span><span class="hljs-strong">_____</span>_
+OPENAI=<span class="hljs-strong">_____</span><span class="hljs-strong">_____</span><span class="hljs-strong">_____</span><span class="hljs-strong">_____</span><span class="hljs-strong">_____</span><span class="hljs-strong">_____</span><span class="hljs-strong">_____</span><span class="hljs-strong">_____</span>
+USE_IMAGES=dalle
+COOLDOWN=5
+</code></pre></li>
+</ul>
+<h2 id="utilisation">Utilisation</h2>
+<ul>
+<li>Exécutez le fichier <code>main.py</code> dans un terminal ouvert dans le dossier presentator:<pre><code><span class="hljs-keyword">python</span> main.<span class="hljs-keyword">py</span>
+</code></pre></li>
+<li>Rendez vous sur discord</li>
+<li>A gauche de votre écran, vous devriez voir une icone ronde avec une lettre au millieu. Il s&#39;agit de votre serveur.</li>
+<li>Rendez vous dans votre serveur en cliquant dessus, puis rendez vous dans général et tapez <code>/present</code> puis la touche tab. Une boite de dialogue devrait s&#39;afficher avec le subject, sujet de votre présentation.</li>
+<li>Dans le serveur discord qu</li>
+</ul>