Comment transformer un README GitHub en PDF

Convertissez des fichiers README en PDF pour la relecture

Un README est souvent la meilleure explication courte d’un projet, mais tout le monde n’a pas envie de le lire dans GitHub. Le convertir en PDF le rend plus simple à faire circuler dans un processus de validation, d’achat, de livraison client ou de lecture hors ligne.

Le principal travail de nettoyage consiste souvent à retirer le bruit propre à GitHub. Supprimez les badges sans intérêt pour le lecteur, raccourcissez les étapes d’installation trop longues et remplacez certaines captures d’écran par des explications markdown si nécessaire.

Ce qu’il faut garder

• Présentation du projet
• Étapes d’installation ou d’usage
• Liens importants
• Tableaux utiles et exemples de code

Ce qu’il faut raccourcir

• Notes de contribution réservées à l’interne
• Badges de build sans intérêt pour le lecteur
• Sections de changelog beaucoup trop longues