⚡ ajout de générateur de structure, complétion de documentation, script de mise à jour du dépot de livre

README.md

@@ -8,9 +8,10 @@ Les fichiers orgmode générés disposent d'un identifiant unique généré alé
 - python
 - pandoc
 - matplotlib (pour les diagrammes de gantt)
+- argparse
 
 sudo apt install python pandoc python-pip
-pip install matplotlib
+pip install matplotlib argparse
 
 ## Démarrer
 Après avoir installé les dépendances, vous pouvez générer un dossier de nouveau livre. Attention, la génération d'un dossier supprime celui qui existait précédemment.
@@ -21,7 +22,9 @@ Celui ci contiendra différents fichiers orgmode ou markdown avec une copie des
 Et hop, vous obtenez un sous dossier `le_nom_du_livre` qui contient de quoi faire avancer votre histoire.
 # À quoi servent les différents fichiers
 ## Livre
-C'est ici que votre récit se déroule.
+C'est ici que votre récit se déroule. Tous les chapitres sont censés s'y trouver.
+Vous pouvez mettre des commentaires au sein du texte avec des marqueurs Orgmode de cmomentaires.
+
 Afin d'avoir une structure qui aura visuellement du sens pour l'autrice du livre, seuls les titres ayant un tag :title: seront rendus lors de l'export. Cela permet de sectionner les étapes de l'histoire sans afficher ces titres de sections dans le livre final.
 Votre livre peut contenir des médias, nous vous invitons à les placer dans le dossier "assets".
 Le dossier "inspirations" est destiné à avoir des images, des médias, des documents divers, une bibliographie, c'est toujours utile de référencer ses inspirations pour clarifier ce que l'on aimerait raconter. 
@@ -41,20 +44,38 @@ Décrit les thématiques que vous souhaitez aborder et ce que vous souhaitez exp
 
 # Les scripts
 Permettent de transformer votre livre en produit distribuable: ebook, html, pdf, mais aussi d'avoir une meilleure vue sur votre livre avec un tableau listant automatiquement les occurences de vos personnages trouvés dans chaque chapitre ainsi qu'un diagramme montrant les superpositions d'intrigues. Voir pour cela les descriptions dans `À quoi servent les différents fichiers`
+### Génération de plan de livre
+`python structure_generator.py`
+Génère un plan de chapitres selon les nombres de chapitres, de sous parties, et d'objectif de mots par section donnés.
+Il ne reste plus qu'à copier le texte donné dans livre.org
 
 ### Conversion du livre
+Conversion en epub, html, et pdf grâce à pandoc.
 `python render_ebook.py`
 
 ### Statistiques
 `bash up_infos.sh`
 
+# Mettre à jour mon livre
+Ce dépot évolue, pour profiter de ses évolutions il vous suffit de copier les scripts dans le dossier de votre livre.
+
+`bash update_book.sh nom_du_dossier_livre`
+
+# Tâches personnelles
+On utilise par défaut des fichiers Orgmode, alors n'oublions pas de jeter un oeil à ce que l'on pourrait faire avec ce fichier `taches_nom_de_mon_livre.org`. à commencer par l'ajouter à sa liste de fichiers dans son agenda personnel.
+
 # Développement en cours
 ## Objectifs de rédaction en nombre de mots plus fins.
 Par défaut, le script déterminant la tenue des objectifs de rédaction se base sur une valeur fixe pour tous les chapitres.
 Vous pouvez modifier cet objectif dans `stats_chapitres.py` puis lancer la mise à jour des informations statistiques.
-## Génération d'intrigues calibrées
-Un script permettant de générer une suite d'intrigues découpées selon des objectifs de rédaction est prévu.
-Il permettra de définir un nombre de chapitres, scènes et séquences avec une seule commande.
+
+Un tag ajouté aux entêtes de chapitre permet de définir des objectifs de mots.
+:target_500: définit une cible à 500 mots, :target_1200: défniit la cible à 1200. Cela permettra au générateur de statistiques d'affiner son avancée plus finement. Ce sont des indicateurs, dans la réalité les auteurs écrivent leurs chapitres avec des volumes très variables.
+
+## Suivi de progression de la rédaction
+
+Il est envisagé que chaque génération de mise à jour des statistiques remplisse un fichier csv de suivi daté afin de pouvoir voir sa progression quotidienne.
+La génération de données statistiques peut être incluse dans une tâche cron pour ne pas avoir à faire de lancement de commande tous les jours.
 
 # Licence
 AGPLv3+