Skapa en README

Introduktion till GitHub-koncept

Jasmin Ludolf

Content Developer, DataCamp

Redigera README

Vy över fotbollsanalysrepot

Introduktion till GitHub-koncept

Redigera README

Vy över fotbollsanalysrepot med README-filen markerad

Introduktion till GitHub-koncept

Redigera README

Vy över fotbollsanalysrepot med pennikonen för att redigera README-filen markerad

Introduktion till GitHub-koncept

Markdown

Vy över README-filen

Introduktion till GitHub-koncept

Redigera vs. förhandsgranska

Vy över README-filen med flikarna Redigera och Förhandsgranska markerade

Introduktion till GitHub-koncept

Rubriker

Vy över en Markdown-fils redigeringssida med syntax för den största rubriken

Vy över en Markdown-fils förhandsgranskningssida med den största rubriken

Introduktion till GitHub-koncept

Rubriker

Vy över en Markdown-fils redigeringssida med syntax för alla sex rubriknivåer

Vy över en Markdown-fils förhandsgranskningssida med alla sex rubriknivåer

Introduktion till GitHub-koncept

Rubriker

Vy över en Markdown-fils redigeringssida med syntax för alla sex rubriknivåer]

Vy över en Markdown-fils förhandsgranskningssida med alla sex rubriknivåer och pilar som pekar på linjerna under rubrik ett och rubrik två

Introduktion till GitHub-koncept

Textformatering

Vy över en Markdown-fils redigeringssida med syntax för fet och kursiv stil

Vy över en Markdown-fils förhandsgranskningssida med fet och kursiv text

Introduktion till GitHub-koncept

Hyperlänkar

Vy över en Markdown-fils redigeringssida med syntax för en hyperlänk

Vy över en Markdown-fils förhandsgranskningssida med en hyperlänk

Introduktion till GitHub-koncept

Hyperlänkar

Animerad vy av ett klick på en hyperlänk

Introduktion till GitHub-koncept

Bilder

Animerad vy av att en bild dras in i Markdown-filen och GitHub automatiskt renderar syntaxen

Introduktion till GitHub-koncept

Skriva en README

  • Ska vara beskrivande
    • Alla ska förstå projektet
  • Lista repots innehåll
  • Förklarar projektet tydligt för andra

Illustration av en öppen bok

Introduktion till GitHub-koncept

README-grunderna

  • Titel
  • Beskrivning av tekniken
    • Varför?
  • Beskrivning av processen
    • Varför?
  • Innehållsförteckning
Introduktion till GitHub-koncept

README-tillägg

  • Hur projektet uppstod
  • Motivationen
  • Begränsningar
  • Utmaningar
  • Vilket problem det syftar till att lösa
  • Tänkt användningsområde
  • Erkännanden
Introduktion till GitHub-koncept

Nu kör vi en övning!

Introduktion till GitHub-koncept

Preparing Video For Download...