How To README · Matthias Ott – User Experience Designer
mercredi 26 avril 2023 à 09:36En résumé, pour un bon .README, il faut les paragraphes:
- Nom et description
- Installation
- Configuration et usage
- Déploiement
- Testing (tests unitaires ? Lol)
- Comment contribuer
- Licence
- Roadmap (modifs à venir)
- Changelog (liste des versions et des apports de chacune)
- Author(s) / Contributeurs.trices
- ajouter un lien de démo
- ET UNE FUCKING CAPTURE D'ÉCRAN !
Pour ma part, et comme un des commentateurs, je pense qu'il faudrait mettre le changelog dans un fichier séparé.
Via https://links.kalvn.net/shaare/YUH_nQ
<link rel="stylesheet" href="http://www.warriordudimanche.net/./plugins/Galart/style.css"/>
<link rel="stylesheet" href="http://www.warriordudimanche.net/./plugins/Galart/assets/lightbox.css"/>
<script src="http://www.warriordudimanche.net/./plugins/Galart/assets/lightbox.js">
<script>[].forEach.call(document.querySelectorAll("[lightbox]"), function(el) { el.lightbox = new Lightbox(el);});► Commentaires