Alors, ce genre d’initiative est très intéressante, mais il y a quelques problèmes quand même.
Déjà, sur la forme, je ne comprends pas la mise en forme de ton fichier README.md, tu as mis des blocs de code pour une partie de ton texte (au fait, c’est « le mien »). Je te conseille aussi de mettre un README.md à la racine et d’y mettre aussi la licence au lieu de la mettre en double exemplaire dans chaque sous-dossier (à moins de faire deux dépôts différents).
Ensuite, je vois que tu as, dans le dépôt même, trois versions de ton document. je te conseille plutôt de faire ton choix entre texte brut et fichier odt (j’aurais plutôt mis un fodt, mais c’est mon point de vue), je te conseille de faire ton choix entre ces deux formats afin d’éviter d’avoir deux versions à maintenir. Si tu maîtrises le Markdown, c’est même préférable car il est affichable directement dans Github.
Enfin, la version PDF, c’est une version générée à partir du fichier ODT, donc, elle n’a pas sa place dans un dépôt git. Dans git, tu modifies du code pour en faire des fichiers de sortie, mais en aucun cas tu ne mets les fichiers de sortie dans ton dépôt, il faut spécifier comment le générer, mais il ne faut pas le mettre. Pour le cas de Github, je crois que tu peux l’ajouter dans la release, s’il faut.
Vraiment, je te conseile de ne faire qu’une seule version en Markdown, c’est le mieux à faire.
Pour le fond, c’est un bon début, je n’ai pas « testé » ta documentation. J’aurais vu l’avertissement sur le dossier .git après le lancement de git init
, et non pas avant. Ce répertoire n’existe pas avant l’exécution de git init
. À la limite, tu peux mettre le git init
juste après l’étape 3 (se déplacer dans le répertoire créé), comme ça, tu envoies le message « voilà, ton espace de travail est créé, fous la paix au dossier .git, mais tout le reste est à toi ».
Il faudrait faire quelque chose pour le lexique, j’ai un peu l’impression d’avoir allumé ma moissoneuse-batteuse pour cueillir une margueritte. Et c’est quoi ça ?