Création d'un fichier README

Introduction aux concepts de GitHub

Jasmin Ludolf

Content Developer, DataCamp

Modifier le fichier README

Vue du dépôt d'analyse du football

Introduction aux concepts de GitHub

Modifier le fichier README

Vue du dépôt d'analyse du football avec le fichier README mis en évidence

Introduction aux concepts de GitHub

Modifier le fichier README

Vue du dépôt d'analyse de football avec l'icône en forme de crayon pour modifier le fichier README mis en évidence

Introduction aux concepts de GitHub

Markdown

Vue du fichier README

Introduction aux concepts de GitHub

Modifier vs. prévisualiser

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

Introduction aux concepts de GitHub

Titres

Vue d'une page d'édition de fichier Markdown avec la syntaxe pour le titre le plus grand

Vue d'une page d'aperçu d'un fichier Markdown avec le plus grand titre

Introduction aux concepts de GitHub

Titres

Vue d'une page d'édition de fichier Markdown avec la syntaxe pour les six types d'en-têtes

Vue d'une page d'aperçu d'un fichier Markdown avec les six types d'en-têtes

Introduction aux concepts de GitHub

Titres

Vue d'une page d'édition de fichier Markdown avec la syntaxe pour les six types d'en-têtes]

Vue d'une page d'aperçu d'un fichier Markdown avec les six types d'en-têtes et des flèches indiquant les lignes sous l'en-tête un et l'en-tête deux

Introduction aux concepts de GitHub

Formatage du texte

Vue d'une page d'édition de fichier Markdown avec syntaxe pour le gras et l'italique

Vue d'une page d'aperçu d'un fichier Markdown avec du texte en gras et en italique

Introduction aux concepts de GitHub

Liens hypertextes

Vue d'une page d'édition de fichier Markdown avec syntaxe pour un lien hypertexte

Vue d'une page d'aperçu d'un fichier Markdown avec un lien hypertexte

Introduction aux concepts de GitHub

Liens hypertextes

Animation illustrant le clic sur un lien hypertexte

Introduction aux concepts de GitHub

Images

Vue animée illustrant le glissement d'une image dans le fichier Markdown et le rendu automatique de la syntaxe par GitHub

Introduction aux concepts de GitHub

Rédaction d'un fichier README

  • Il est nécessaire d'être descriptif
    • Tout le monde devrait comprendre notre projet
  • Énumérez le contenu du dépôt
  • Expliquez clairement le projet aux autres

Illustration d'un livre ouvert

Introduction aux concepts de GitHub

Principes fondamentaux du fichier README

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

Informations supplémentaires sur README

  • Comment le projet a vu le jour
  • La motivation
  • Les limites
  • Les difficultés
  • Quel problème espère-t-on résoudre ?
  • Quelle est l'utilisation prévue ?
  • Crédits
Introduction aux concepts de GitHub

Passons à la pratique !

Introduction aux concepts de GitHub

Preparing Video For Download...