Modèle de readme pour les mods publiés sur La Couronne

[Freddy_Gwendo]

Modèles de fichiers readme pour les mods de La Couronne de Cuivre (v7.0.1)

Ces modèles de fichiers readme sont destinés aux mods développés et/ou publiés sur la Couronne de Cuivre. Je me suis inspiré des readme des forums anglo-saxons tout en m'efforçant de conserver les codes couleurs utilisés par le forum de La Couronne de Cuivre (sans oublier sa bannière, merci Mornagest ), même si ce n'est pas toujours évident.

Dans chaque section, j'ai repris, chaque fois que possible, des éléments de traductions déjà publiées (par les d'Oghms ou par bibi) afin de conserver un semblant d'homogénéité dans les termes employés.

Il vous suffira de conserver les éléments dont vous avez besoin (liste des jeux compatibles, procédures d'installation selon la plateforme, liste des outils utilisés...) et, pour le reste, de remplacer MYMOD et Auteur par les noms du mod et de son auteur, de modifier les liens et de remplir les textes adéquats. Pour certaines sections, j'ai été le plus exhaustif possible : il vous suffit de choisir les paragraphes (et quelquefois le format d'affichage) qui vous intéressent et de supprimer les autres.

Le modèle est proposé en quatre versions : skin LCC classique et skin BG2, les deux déclinées en français et en anglais.

Il n'est pas figé et je suis prêt à le modifier selon vos suggestions.


J'ai transféré le projet sur GitHub, ce qui désencombrera le fofo. Vous y trouverez la dernière version.

Github ! Téléchargement de la dernière version

Français normal | Français skin BG2 | Anglais normal | Anglais skin BG2

[Freddy_Gwendo]

Seconde version (v1.1) : un drapeau permet de passer du readme français à l'anglais, et lycée de Versailles.

[Freddy_Gwendo]

J'ai repéré quelques typos et l'oubli d'une traduction dans la version anglaise. J'attends quelques retours éventuels avant de mettre à jour l'archive.

[Isaya]

Je n'ai pas étudié le contenu en termes de texte mais la mise en page.

J'ai relevé une erreur de syntaxe :

Code : Tout sélectionner

		<ul>
			<li>modification[color="#FF0000"]</li>[/color] <!-- erroné, doit âtre après le bloc <ul>...</ul> -->
				<ul>
					<li style="margin-left: -70px"></li>
					<li style="margin-left: -70px"></li>
				</ul>
			[color="#008000"]</li>[/color] <!-- fermeture du li à placer ici pour que le bloc <ul>...</ul> soit effectivement d'un niveau inférieur -->
			<li>Updated installer <acronym title="Weimer Dialogue Utility">WeiDU</acronym> to v246.</li>
		</ul>

Par ailleurs voici une proposition pour retirer le besoin d'ajouter un retrait de -70px dans les éléments de liste de deuxième niveau :

Code : Tout sélectionner

	#maindiv ul {
		line-height: 170%;
		margin-left: 4%;
		width: 87%;
	}
	#maindiv ul li {
	}
	#maindiv ul li ul {
		margin: 0px;
		width: 95%;
	}
	#maindiv ul li ul li {
	}

C'est un peu compliqué parce que la mise en page utilise à la fois des pourcentages (largeur utile de 90 % un peu partout) et des pixels. Du coup j'ai réduit la largeur en % et fixé les marges en % également. En créant une règle pour la liste incluse dans une autre et en fixant la marge à 0 (elle a une valeur par défaut supérieure) et en augmentant la largeur dans ce cas, on obtient à peu-près le même effet que le retrait de -70px, avec une assez bonne exploitation de la largeur au deuxième niveau.
J'ai testé avec des largeurs de fenêtre entre environ 1024 et 1920 pixels, avec Firefox et IE.

Voici un exemple vf avec des textes longs dans l'historique pour vérifier la façon dont la troncature s'effectue, avec la v1.1 comme point de départ.

[Freddy_Gwendo]

Merci pour le retour.

Le premier point faisait partie des typos que je mentionnais. Je l'ai déjà corrigé.

Quant au second, je comptais me plonger dans la doc HTML pour mieux comprendre l'utilisation des pourcentages dans le formatage des blocs, mais, pris par le temps pour sortir BuTcHeRy, j'ai paré au plus pressé. Ton code est beaucoup plus élégant, et surtout il pourra être aisément modifié selon les usages, notamment pour le prochain readme d'1PP qui utilise plusieurs niveaux de listes. Je l'intègrerai donc dans la future version.

Elle comprendra aussi deux readme.md pour les dépôts GitHub. C'est plus compliqué à écrire parce Markdown ne reconnait pas tous codes HTML et plusieurs formatages sont impossibles à réaliser. Mais au final, je pense avoir produit un canevas utilisable.

[Freddy_Gwendo]

Mise à jour : version 2.0.0

• Correction de liens erronés, de typos, et ajout de Blender dans les outils
• Ajout de la proposition d'Isaya pour gérer les listes à plusieurs niveaux. Je l'ai modifiée pour ajouter un niveau supplémentaire de liste.
• Ajout de la procédure de lecture des fichiers ini qui sera utilisée par les prochains outils d'installation automatique
• Ajout des fichiers .md pour les dépôts github
• Ajout de plusieurs drapeaux étrangers

J'ai ouvert un dépôt GitHub pour mieux gérer les modifs. Le lien se trouve dans le premier message.

[Freddy_Gwendo]

Mise à jour : version 3.0.0

• Ajout de balises spoilers dans les fichiers html et md
• Ajout d'un petit bonus dans la section Présentation du fichier html
• Corrections mineures diverses

[Freddy_Gwendo]

De nouvelles améliorations, notamment dues à une pratique plus intensive de markdown.


Modifications générales (fichiers .html et .md) :

• Correction de typos.
• Ajouts de lignes de séparations manquantes.
• Section Installation :
  • Réécriture de la procédure.
  • Modification du nom des fichiers ini.
  • Ajout du traitement des chaînes de caractères dans les fichiers ini.
• Section Composants :
  • Suppression de la référence au BiG World Setup, obsolète et plus maintenu.
  • Traduction en anglais du tableau.
  • Ajout d'une présentation alternative si le mod comprend au moins une dizaine de composants.
• Section Crédits et remerciements :
  • Mise à jour des liens GitHub pour WeiDU et NearInfinity.

readme-lcc.html

• Reformatage (notamment introduction du code Dos).

readme.md

• Modifications générales :
  • Ajout de badges en en-tête.
  • Centrage du nom du mod en en-tête.
  • Utilisation des codes de formatage markdown.
  • Alignement à droite du retour en haut de page.
  • Ajout de liens vers deux listes de codes de smileys et d'emoji utilisables par markdown.
  • Ajout du "truc" pour souligner un texte.
• Section Compatibilité :
  • Ajout des lignes manquantes en anglais.

Enjoy.

[Freddy_Gwendo]

Je dispose d'une nouvelle version sous le coude, mais avant de la publier, j'aimerais que des utilisateurs de mac et de linux vérifient la véracité de la procédure d'installation proposée et, le cas échéant, m'indiquent quelles améliorations y apporter.

Merci d’avance.

[Mornagest]

Pour la procédure d'installation sur GNU/Linux, j'ajouterais qu'il faut également copier tolower dans /usr/bin, sans quoi l'exécutable n'est pas appelable (puisqu'absent).

Également, pour installer un mod, il faut écrire weinstall sans majuscule. Aucun exécutable Linux ne comporte de majuscule.

Merci pour tes modèles !

[Freddy_Gwendo]

Il me semblait que tolower était inclus dans l'archive WeiDU pour linux, mais je peux me tromper. Il faut que je vérifie.
Quant à la majuscule, c'est ballot, la seule chose que je connais de linux, c'est le lower case.

Pour info, je me suis inspiré de ces modèles pour créer les nouveaux pour les mods SHS.

[Mornagest]

Oui, oui, tolower est bien inclus dans l'archive, mais tu dois également le copier dans /usr/bin comme weinstall et weidu sans quoi l'appel de la commande tolower pour tout passer en minuscules ne fonctionnera pas (puisque l'exécutable ne sera pas présent).

Je ne sais pas si je suis très clair, désolé...

[Freddy_Gwendo]

Je crois que j'ai pigé.
Suis un peu claqué ce soir, mais je soumettrai une nouvelle formulation demain et tu me confirmeras si c'est plus clair.

Encore merci.

[Freddy_Gwendo]

Alors, voici les instructions corrigées pour linux :

MYMOD pour Linux est diffusé sous forme d'archive compressée (tarball) sans l'installateur WeiDU.
Extrayez le contenu du mod dans le répertoire du jeu que vous voulez moder.
Téléchargez la version la plus récente de WeiDU pour Linux sur WeiDU.org et copiez weidu, weinstall et tolower dans /usr/bin. Ouvrez ensuite un terminal et allez cd dans le répertoire d'installation de votre jeu, lancez « tolower » et répondez « Y » aux deux questions. Vous pouvez éviter d'exécuter la seconde option (Linux.ini) si vous l'avez déjà lancée une fois dans le même dossier. Pour gagner du temps, l'archive est déjà passée en minuscules, aussi il n'est pas non plus nécessaire d'exécuter la première option (passer les noms de fichiers en minuscules) si vous n'avez extrait que ce mod depuis la dernière fois que vous avez passé les noms de fichiers en minuscules. Si vous avez un doute, il vaut mieux exécuter tolower et accepter les deux options.

Lancez "weinstall setup-mymod" depuis le dossier de votre jeu pour installer le mod. Puis, lancez "wine bgmain.exe"et commencez à jouer.

Ça roule comme ça ?

[vv221]

Pour la copie des binaires je conseille de remplacer :

copiez weidu, weinstall et tolower dans /usr/bin

par :

copiez weidu, weinstall et tolower dans /usr/local/bin

L’avantage c’est que ça évite de les mélanger aux binaires fournis par le système, et rend *beaucoup* moins dangereux une éventuelle fausse manipulation.
L’inconvénient c’est que ce répertoire peut ne pas exister sur la machine du lecteur du guide, qui devra alors le créer.

La convention veut généralement que /usr/bin soit le territoire des binaires gérés par le système de paquets de la distribution, et /usr/local/bin celui des binaires gérés par l’administrateur de la machine.

[Freddy_Gwendo]

Merci. Pour vérification, tu trouveras les liens pour les afficher ici. Lorsque le formatage et le texte seront finalisés, je rapatrierai les liens ici.

[Isaya]

Même si je reconnais que c'est plus propre, il y a tout de même un inconvénient à différer de l'emplacement habituellement recommandé dans les autres readme ou les tutoriels. Les gens pourraient se demander pourquoi.

En tout cas, si tu stipules de copier dans /usr/local/bin, qui n'est généralement pas dans le PATH (d'autant moins si on le crée à cette occasion), cela va poser un problème pour lancer tolower et weinstall. Pour le premier, tu pourrais demander de lancer "/usr/local/bin/tolower". Pour le second, l'ajout du chemin ne suffira pas si weinstall appelle ensuite weidu, ce qui est probable vu leurs tailles respectives. Donc au final, le plus sûr serait d'ajouter, au moins avant de lancer weinstall, de taper la commande

Code : Tout sélectionner

export PATH=$PATH:/usr/local/bin

[Freddy_Gwendo]

wouah... c'est en train de devenir une véritable usine à gaz ce truc. Bon, je proposerai les deux versions demain. Et les utilisateurs de linux trancheront.

[Freddy_Gwendo]

Elle était dans les cartons depuis un moment, et j'ai profité de la sortie de la nouvelle skin du forum pour l’officialiser.


Modifications générales (fichiers .html et .md) :

• Correction des derniers typos (enfin, je l'espère).
• Externalisation des paramètres de style dans les fichiers style_lcc.css et style_lcc_bg2.css.
• Externalisation du code javascript dans le fichier script_astuce.js.
• Skin BG2 : ajout d'une infobulle personnalisée en remplacement de la balise `acronym`.
• Tous les fichiers images sont désormais en minuscules.
• Section Compatibilité : Ajout de la mention du patch pour les utilisateurs de ToB et des liens pour télécharger les mods de conversions (BGT et EET).
• Section Installation : Remplacement de l'outil modmerge par DLC Merger et ré-écriture de la procédure d'installation linux (merci à Fossy et à vv221 !).
• Section Crédits et remerciements : Ajout de la Creative Commons License.

Fichiers readme-lcc.html

• Ajout d'une version dotée de la nouvelle skin BG2 de LCC ( :!: n'oubliez-pas de supprimer le suffixe "bg2" aux fichiers .html, ainsi que dans les liens qu'ils contiennent pour passer de la version française à la version anglaise, et lycée de Versailles.
• Ajout des captures d'écran superposées.
• Reformatage de nombreuses sections.

Fichiers readme.md

• Suppression des balises `acronym` non visibles dans les fichiers .md.

Et j'ai ajouté des liens qui permettent de visualiser les fichiers html dans le premier message.

Enjoy.

[Cocrane]

Bon...

Je viens de télécharger le modèle.

On édite comment le modèle?

J'ai l'impression d'avoir raté une marche et d'avoir dévalé un escalier en mode Carl Lewis.

Ca fait mal.

Putain de BG, tout est compliqué pour faire mod, même le partage. PTDR

Ahh ca fait du bien de rire un coup.


Cocrane

[Freddy_Gwendo]

Modèles créés et édités avec Notepad++. Je pense que n'importe quel éditeur de texte doit fonctionner.

Édit : l'avantage de Notepad++, c'est qu'il dispose de Highlighters intégrés pour HTLM et MD.

[Cocrane]

J'avais oublié que le HTML était du texte à la base.

Je vois plusieurs fichiers, vu que mon mod est uniquement en Français, j'ai juste readme-lcc-fr.html à mettre à jour?

Cocrane

[Freddy_Gwendo]

Yes, sir.
Tu peux choisir quelle version tu souhaites utiliser : le style classique de LCC ou le nouveau de BG2.

[Freddy_Gwendo]

Beaucoup de nouveautés.

Français normal | Français skin BG2 | Anglais normal | Anglais skin BG2

☛ Modifications générales (fichiers .html et .md) :

• Création du dossier mymod.
• Modification du nom des fichiers .ini et ajout de modèles dans le dossier /mymod.
• Ajout du fichier activity.md regroupant de nombreux badges GitHub permettant de gérer le dépôt, en anglais et en français.
• Ajout du fichier MAINTENANCE-NOTICE.md.
• Correction de typos.
• Ajout de lignes de séparations manquantes.
• Mise à jour des liens obsolètes.
• Diverses modifications cosmétiques.
• Section Présentation :
  • Ajout du paragraphe "Contenu".
  • Ajout de liens vers des mises en page plus complexes.
• Section Compatibilité :
  • Ajout du paragraphe "Jeux concernés".
  • Ajout du paragraphe "Compatibilité avec les autres mods".
  • Ajout du paragraphe "Ordre d'installation".
• Section Installation :
  • Mise à jour des procédures d'installation (Mac OS X et Linux) : le mod est diffusé dans la même archive quel que soit le système d'exploitation.
• Sections Composants :
  • Remise en forme complète des deux sections.
• Section Dépannage :
  • Ajout d'un symptôme identifié.
• Section Historique des versions :
  • Ajout du paragraphe sur l'utilitaire "Infinity Auto Packager".
  • Remise en forme complète de la section.

☛ Fichiers .html :

• Ajout d'un script qui modifie automatiquement le numéro de version dans l'en-tête à partir de la dernière version saisi dans la partie Historique des versions.
• Ajout de l'icône de LCC apparaissant dans le navigateur.
• Ajout d'une ombre portée au titre du mod.
• Traduction des chaînes de caractères à afficher par le code javascript en anglais dans le fichier "script_astuce_en.js".
• Section Compatibilité : ajout de la classe "important_tuto".
• Section Installation : ajout des info-bulles manquantes.
• Sections Composants :
  • Ajout d'une nouvelle image de background pour la présentation alternative des composants.
  • Ajout de de la classe "tp2".
  • Ajout des info-bulles manquantes.

☛ Fichiers readme.md :

• Ajout des badges d'en-tête de plateforme Mac et Linux.
• Ajout des badges d'en-tête personnalisés de statistiques de téléchargement.
• Ajout des badges d'en-tête personnalisés de statistiques sur le dépôt et sur son activité.
• Traduction en français des badges d'en-tête.
• Ajout du lien permettant d'afficher les readme Markdown français et anglais.

[Freddy_Gwendo]

Quelques nouveautés issues de mes dernières mises à jour sur SHS.

Français normal | Français skin BG2 | Anglais normal | Anglais skin BG2

☛ Modifications générales (fichiers .html et .md) :

• Correction de typos.
• Ajout des sections Détails (pour les mods de PNJ) et FAQ.
• Ajout de la présentation de vidéos dans la section Images.
• Section Compatibilité : mise à jour du lien de téléchargement de EET (dépôt GitHub de G3).
• Sections Composants : ajout de la mention de pré-requis pour certains composants.

☛ Fichiers .html :

• Ajout de nouveaux codes de smileys et de caractères spéciaux.
• Ajout des balises `acronym` et des info-bulles manquantes.
• Section Présentation :
  • Ajout d'une nouvelle présentation du contenu du mod avec la classe "important".
  • Ajout des highlighters de code WeiDU dans la classe "important_tuto".
• Section Compatibilité : ajout du mot-clé LabelType dans le fichier mymod.ini.
• Sections Composants : amélioration de la mise en forme (purement cosmétique).
• Section Dépannage : formatage plus lisible des résolutions de problème.

☛ Fichiers readme.md :

• Ajout de Project Infinity dans le badge d'en-tête des plateformes.
• Ajout des badges d'en-tête des Jeux supportés par le mod.
• Ajout d'icônes pour lire le readme et télécharger le mod.
• Suppression des badges d'en-tête de statistiques sur le dépôt et sur son activité (redondant car présents dans le fichier activity.md.

[Freddy_Gwendo]

Désolé, petite mise à jour : Ajout de l'onglet manquant "Contenu du mod / Mod Details" dans le menu.