Een README maken

Introductie tot GitHub-concepten

Jasmin Ludolf

Content Developer, DataCamp

README bewerken

Weergave van de soccer-analyse-repo

Introductie tot GitHub-concepten

README bewerken

Weergave van de soccer-analyse-repo met het README-bestand gemarkeerd

Introductie tot GitHub-concepten

README bewerken

Weergave van de soccer-analyse-repo met het potloodpictogram om het README-bestand te bewerken gemarkeerd

Introductie tot GitHub-concepten

Markdown

Weergave van het README-bestand

Introductie tot GitHub-concepten

Bewerken vs. Voorbeeld

Weergave van het README-bestand met de tabs Bewerken en Voorbeeld gemarkeerd

Introductie tot GitHub-concepten

Koppen

Weergave van een markdown-bewerkpagina met syntaxis voor de grootste kop

Weergave van een markdown-voorbeeldpagina met de grootste kop

Introductie tot GitHub-concepten

Koppen

Weergave van een markdown-bewerkpagina met syntaxis voor alle zes koptypen

Weergave van een markdown-voorbeeldpagina met alle zes koptypen

Introductie tot GitHub-concepten

Koppen

Weergave van een markdown-bewerkpagina met syntaxis voor alle zes koptypen]

Weergave van een markdown-voorbeeldpagina met alle zes koptypen en pijlen die wijzen naar de lijnen onder kop één en kop twee

Introductie tot GitHub-concepten

Tekstopmaak

Weergave van een markdown-bewerkpagina met syntaxis voor vet en cursief

Weergave van een markdown-voorbeeldpagina met vette en cursieve tekst

Introductie tot GitHub-concepten

Hyperlinks

Weergave van een markdown-bewerkpagina met syntaxis voor een hyperlink

Weergave van een markdown-voorbeeldpagina met een hyperlink

Introductie tot GitHub-concepten

Hyperlinks

Geanimeerde weergave van het klikken op een hyperlink

Introductie tot GitHub-concepten

Afbeeldingen

Geanimeerde weergave van een afbeelding naar het markdown-bestand slepen waarna GitHub automatisch de syntaxis rendert

Introductie tot GitHub-concepten

Een README schrijven

  • Moet beschrijvend zijn
    • Iedereen moet ons project snappen
  • Inhoud van de repository opsommen
  • Legt het project duidelijk uit aan anderen

Illustratie van een open boek

Introductie tot GitHub-concepten

README-basics

  • Titel
  • Beschrijving van de technologie
    • Waarom?
  • Beschrijving van het proces
    • Waarom?
  • Inhoudsopgave
Introductie tot GitHub-concepten

README-extra's

  • Hoe het project is ontstaan
  • De motivatie
  • Beperkingen
  • Uitdagingen
  • Welk probleem het wil oplossen
  • Het beoogde gebruik
  • Vermeldingen/credits
Introductie tot GitHub-concepten

Laten we oefenen!

Introductie tot GitHub-concepten

Preparing Video For Download...