diff --git a/README-fr.md b/README-fr.md index f4e86a0..eff6417 100644 --- a/README-fr.md +++ b/README-fr.md @@ -1 +1,83 @@ -
+ +
+ ++ + + +
+ ++ +> Choisissez un nom que vos visiteurs pourront facilement retenir. + +
++ +> Le README est la première choses que les visiteurs verront sur la page de votre projet. Travaillez la présentation pour qu'elle soit simple, jolie et agréable à lire. [Vous trouverez des exemples de README soignés ici.](https://github.com/matiassingers/awesome-readme) + +
++ +> Identifiez les points forts de votre projet et mettez les en avant de manière à ce que ce soit la première chose que voient vos visiteurs. + +
++ +> Vos visiteurs voudront comprendre rapidement à quel besoin répond votre projet et comment il fonctionne. Mettre une démo à disposition est un excellente moyen de satisfaire vos visiteurs. Le format de la démo peut être : +> +> - un GIF animé +> - un lien vers un démo en ligne + +
++ +> Vous risquez de perdre des visiteurs si le projet n'est pas simple à installer/utiliser. + +
++ +> Créer un bonne documentation est probablement l'étape la plus importante. Si votre documentation n'est pas longue, vous pouvez l'inclure directement dans votre README. Si celle-ci est volumineuse, le mieux sera de l'héberger sur un site différent. Certains projets open-source comme [vuepress](https://v1.vuepress.vuejs.org) permettent de créer rapidement une jolie documentation. + +
+