Il y a quelques jours, j'ai vu passer un article sur le contenu idéal d'un Readme ( https://warriordudimanche.net/article1840/6448d4a15a710 ) et en partageant le lien sur mastodon, on a émis l'idée de coder un assistant de génération qui permette de faire ça simplement...

Nicolas Delsaux* m'a alors passé quelques exemples d'applis déjà réalisées et - pour autant que j'ai pu en juger avec un test rapide - très bien foutues et très complètes:

• https://www.npmjs.com/package/readme-md-generator réalisé par quelques uns de ses collègues
• https://readme.so/fr

Hélas... vous me connaissez...

le malheur était déjà en train de se produire: impossible d'empêcher mon cerveau de travailler en background façon «à la volette»

Du coup, si je voulais pouvoir faire autre chose, il fallait d'abord vider ma tête de ce «projet» LOL.

Voici donc ReadmeToaster

L'objectif est de pouvoir faire un readme rapidement, de pouvoir modifier «simplement» les éléments du contenu (ordre ou items), de pouvoir ajouter des captures d'écran, sélectionner une license...

La capture d'écran parle d'elle-même: on peut même choisir de générer des fichiers séparés pour certaines parties (Roadmap, Changelog...)

Configuration

La configuration des items se fait via le fichier config/patrs.json qui contient les objets, leur type (select/text/textarea etc), leur titre/label, leur placeholder, leur attribut name etc.

    "Name":{
        "type":"text",
        "title":"The project name",
        "name":"name",
        "placeholder":"ReadmeToaster",
        "class":"name",
        "required":"required"
    },
    "Description":{
        "type":"textarea",
        "title":"A short description (what's the project's purpose ?)",
        "name":"description",
        "placeholder":"A tiny webapp to create normalised readme files",
        "class":"description"
    },
    "Installation":{
        "type":"textarea",
        "title":"How to install or deploy ?",
        "name":"installation",
        "placeholder":"Just copy the folder onto your server and that's it... Noooo, I'm kidding !",
        "class":"install"
    },
    "Contribute":{
        "type":"textarea",
        "name":"contribute",
        "placeholder":"* translations,n* bug finding",
        "class":"text",
        "title":"Explain how to contribute"
    },
    "Contribute in a separated file":{
        "type":"checkbox",
        "name":"contribute_separate",
        "title":"Put contribute in a separate file",
        "placeholder":"",
        "class":"",
        "value":"contribute_text"
    },

On peut ainsi facilement ajouter, modifier ou déplacer des items dans le frontend sans mettre les doigts dans le code. Si on peut pouvoir séparer un contenu dans un fichier à part, on colle un item checkbox dont le nom est ITEM_separate.

Le fichier généré sera un zip contenant tous les fichiers, y compris les éventuelles captures d'écran fournies.

Conclusion

Pas sûr que ça serve à quelqu'un vu que c'est plus un amusement qu'autre chose (ne me jugez pas), mais bon: si jamais quelqu'un le veut... c'est par là : https://outils.warriordudimanche.net/outils/readmetoaster/ et pour le télécharger: http://outils.warriordudimanche.net/outils/readmetoaster/?download

ET EN TOUT CAS, C'EST PLUS DANS MA TÊTE !

[*] Pub gratuite pour Nicolas

• https://framapiaf.org/@Riduidel
• https://nicolas-delsaux.hd.free.fr/Shaarli
• https://riduidel.wordpress.com/