Quelle est la meilleure façon de modifier le Readme.md de GitHub ?

Question

Quelle est la meilleure façon de modifier le Readme.md de GitHub ?

Je me retrouve à éditer le Readme, puis je le pousse, je vois des erreurs ou des fautes de formatage, je l'édite à nouveau, puis je le pousse...

Cela fait vraiment un numéro sur l'historique des livraisons.

Y a-t-il un meilleur moyen ? Ou devrais-je ne pas me préoccuper de l'historique des livraisons et me contenter du Readme ?

Peut-être que je ne devrais même pas utiliser Readme du tout, mais plutôt utiliser GH pages ?

---

Comment puis-je tester ce à quoi ressemblera mon fichier readme.md avant de le commiter sur github ? - Je viens de trouver une question similaire, mais plus verbeuse, ci-dessus.

Answer 1

J'édite juste le readme sur github comme un fichier brut. Vous pouvez voir un aperçu avant de valider les modifications.

Answer 2

http://prose.io est un outil formidable ! Il est hébergé sur les pages Github et est une application sans base de données qui fonctionne totalement via l'API Github. Il possède des fonctionnalités intéressantes pour l'expérience de l'éditeur si vous avez également un site GitHub Jekyll.

Et hé, c'est une source ouverte ! http://github.com/prose/prose

Answer 3

Je propose stackedit qui est un éditeur en ligne. Vous n'avez pas besoin d'installer quoi que ce soit.

Il prend également en charge le glisser-déposer du fichier dans l'éditeur lui-même.

Answer 4

Une fois que vous savez comment le formater vous pouvez minimiser les commits à moins que vous ne fassiez des fautes d'orthographe :)

Vous pouvez utiliser l'une des balises suivantes :

• .markdown -- gem install tapis rouge
• .textile -- gem install RedCloth
• .rdoc -- gem install rdoc -v 3.6.1
• .org -- gem install org-ruby
• .creole -- gem install creole
• .mediawiki -- gem install wikicloth
• .rst -- easy_install docutils
• .asciidoc -- brew install asciidoc
• .pod -- Pod::Simple::HTML est livré avec Perl >= 5.10. Les versions inférieures doivent installer - Pod::Simple depuis CPAN.
• .txt -- le texte brut fonctionne bien aussi, si vous ne vous souciez pas du formatage.

Answer 5

En ce qui concerne les pages readme par rapport aux pages GH, gardez à l'esprit que le fichier readme ne doit être que cela : un fichier readme qui sert de point de départ utile pour les informations (instructions d'installation, lien vers la page du projet, etc.) incluses dans une copie d'archive téléchargée de votre projet. Supposons que je télécharge votre projet en tant qu'utilisateur final. J'extrais l'archive. Que dois-je savoir à l'heure actuelle ? C'est ce qui doit figurer dans le fichier readme.

Si vous utilisez le fichier readme comme source principale d'informations sur votre projet parce que de la manière dont GitHub l'affiche de manière proéminente sur la page du projet, vous devez absolument penser à utiliser les pages GH.