Comment créer un  readme github attrayant

Comment créer un readme github attrayant

Avez vous déjà eu l'idée de créer votre Readme GitHub?? Je suppose que la réponse est OUI et c'est une très bonne idée car il s'agit d'une fonctionnalité très intéressante de GitHub qui vous permet d'ajouter du contenu à votre profil. Toute personne qui visite votre profil GitHub aura une idée de qui vous êtes et de toute autre information que vous souhaitez partager, comme votre travail, votre expérience, vos projets, etc.

Dans cet article je vous montre comme le faire en un rien de temps puis vous partager également quelques ressources pour le rendre plus intéressant.

Configuration de votre fichier README.md

Pour configurer votre fichier README.md, suivez les étapes suivantes :

  • Créez un nouveau dépôt (repositery) Github

  • Donnez-lui le même nom que le nom d'utilisateur de votre compte GitHub

Remarque : il doit s'agir exactement du même nom et de la même casse que votre nom d'utilisateur GitHub.

  • Confirmez qu'il s'agit d'un dépôt public et cochez la case permettant d'initier le dépôt avec un fichier README.md.

  • Ouvrez le fichier README.md et rédigez votre contenu avec la syntaxe Markdown. Vous recevez même un modèle gratuit de GitHub que vous pouvez personnaliser à votre goût. Vous pouvez ajouter des images, des textes, des vidéos Youtube, des listes, etc.

Remarque : Markdown est un moyen de styliser du texte sur le Web. Les profils README de GitHub sont écrits en Markdown, ce qui signifie que vous pouvez inclure des GIFs et des images, et pas seulement des textes et des liens. Vous pouvez en apprendre davantage à ce sujet ici :

Ressources Markdown

Première ressource

Deuxième ressource

Conseils supplémentaires :

Comment ajouter un emoji : Les emojis rendent votre contenu plus expressif. Pour insérer un emoji dans votre fichier markdown, choisissez un emoji dans l'une de ces ressources, copiez l'emoji ou le code associé comme :laughing : et collez-le dans votre fichier.

Ressources Emoji :

Première ressource

Deuxième ressource

Comment ajouter des statistiques personnelles GitHub

Les statistiques présentent les rapports liés à votre compte GitHub. Il s'agit plutôt d'un résumé de vos activités. Vous pouvez en créer un pour vous-même à l'aide de cette ressource : Ressource pour le rapport de statistiques de GitHub

Comment ajouter des badges

Les badges sont des moyens sympas de montrer des réalisations ou des informations. Vous pouvez générer des badges, puis les copier et les coller dans votre fichier README.md.

Ressource de badge 1

Ressource pour les badges n°2

Et c'est fini... c'est aussi simple que ça ! Vous avez fini.

Vous ne savez pas comment concevoir le vôtre ? Vous pourrez regardez les des fichiers README d'autres profils, vous aurez une idée unique qui représentera bien votre personnalité.

Tu peux voir le mien ici et pour d'autres profils de la tech ici. Vous pouvez également rechercher vos développeurs et ingénieurs préférés si vous en avez sur GitHub pour voir leurs profils et vous en inspirer.

J'espère que vous avez trouvé cela utile et si c'est le cas n'hésitez pas à me revenir avec des questions ou partager avec d'autres personnes.

Adios !

Did you find this article valuable?

Support ALAO LAWAL ADECHINA by becoming a sponsor. Any amount is appreciated!