Aller au contenu
Korben, roi d’internet, logo bébé avec des lunettes en mode thug life

Créez facilement vos README pour Github

Ça y est vous vous lancez dans la mise en ligne de votre code sur Github. Très cool ! À vous le partage d’un beau projet avec une communauté de développeurs et d’utilisateurs qui vous rejoindront prochainement.

Mais vous allez devoir leur expliquer de quoi il en retourne. La philosophie de votre projet, comment ça s’installe, les fonctionnalités…etc.

Vous devez donc créer votre premier fichier readme. Je sais, c’est peut-être la partie la moins fun. Mais grâce au site Readmi.xyz, vous allez pouvoir faire ça très facilement et surtout très rapidement.

Sur Readmi, tout ce que vous avez à faire, c’est de choisir un template puis le modifier ou alors construire votre fichier readme en y ajoutant les sections dont vous avez besoin. Il suffit de cliquer sur ce que vous voulez rajouter et ça vous ajoutera un petit squelette en HTML que vous n’aurez plus qu’à modifier : Titre, description, liste de fonctionnalité, des liens, des images, de la doc sur les API…etc.

À vous de choisir !

Si ça vous branche, c’est par ici que ça se passe.


Les articles du moment