Créer un README

Introduction aux concepts de GitHub

Jasmin Ludolf

Content Developer, DataCamp

Modifier le README

Vue du dépôt d'analyse de soccer

Introduction aux concepts de GitHub

Modifier le README

Vue du dépôt d'analyse de soccer avec le fichier README en surbrillance

Introduction aux concepts de GitHub

Modifier le README

Vue du dépôt d'analyse de soccer avec l'icône crayon pour modifier le fichier README en surbrillance

Introduction aux concepts de GitHub

Markdown

Vue du fichier README

Introduction aux concepts de GitHub

Modifier vs Aperçu

Vue du fichier README mettant en évidence les onglets d'édition et d'aperçu

Introduction aux concepts de GitHub

Titres

Vue de la page d'édition d'un fichier markdown avec la syntaxe du plus grand titre

Vue de l'aperçu d'un fichier markdown avec le plus grand titre

Introduction aux concepts de GitHub

Titres

Vue de la page d'édition d'un fichier markdown avec la syntaxe des six niveaux de titres

Vue de l'aperçu d'un fichier markdown avec les six niveaux de titres

Introduction aux concepts de GitHub

Titres

Vue de la page d'édition d'un fichier markdown avec la syntaxe des six niveaux de titres]

Vue de l'aperçu d'un fichier markdown avec les six niveaux de titres et des flèches pointant les lignes sous titre un et titre deux

Introduction aux concepts de GitHub

Mise en forme du texte

Vue de la page d'édition d'un fichier markdown avec la syntaxe pour le gras et l'italique

Vue de l'aperçu d'un fichier markdown avec du texte en gras et en italique

Introduction aux concepts de GitHub

Hyperliens

Vue de la page d'édition d'un fichier markdown avec la syntaxe d'un hyperlien

Vue de l'aperçu d'un fichier markdown avec un hyperlien

Introduction aux concepts de GitHub

Hyperliens

Vue animée d'un clic sur un hyperlien

Introduction aux concepts de GitHub

Images

Vue animée du glisser-déposer d'une image dans le fichier markdown et du rendu automatique de la syntaxe par GitHub

Introduction aux concepts de GitHub

Rédiger un README

  • Doivent être descriptifs
    • Tout le monde devrait comprendre notre projet
  • Énumérer le contenu du dépôt
  • Expliquer clairement le projet aux autres

Illustration d'un livre ouvert

Introduction aux concepts de GitHub

Éléments de base d'un README

  • Titre
  • Description de la technologie
    • Pourquoi ?
  • Description du processus
    • Pourquoi ?
  • Table des matières
Introduction aux concepts de GitHub

Extras pour le README

  • Origine du projet
  • Motivation
  • Limitations
  • Défis
  • Problème visé
  • Utilisation prévue
  • Crédits
Introduction aux concepts de GitHub

Passons à la pratique !

Introduction aux concepts de GitHub

Preparing Video For Download...