Vytvoření souboru README

Úvod do GitHubu

Jasmin Ludolf

Content Developer, DataCamp

Úprava souboru README

Zobrazení repozitáře pro analýzu fotbalu

Úvod do GitHubu

Úprava souboru README

Zobrazení repozitáře pro analýzu fotbalu se zvýrazněným souborem README

Úvod do GitHubu

Úprava souboru README

Zobrazení repozitáře pro analýzu fotbalu se zvýrazněnou ikonou tužky pro úpravu souboru README

Úvod do GitHubu

Markdown

Zobrazení souboru README

Úvod do GitHubu

Úprava vs. náhled

Zobrazení souboru README se zvýrazněnými kartami pro úpravu a náhled

Úvod do GitHubu

Nadpisy

Zobrazení stránky pro úpravu souboru Markdown se syntaxí pro největší nadpis

Zobrazení náhledové stránky souboru Markdown s největším nadpisem

Úvod do GitHubu

Nadpisy

Zobrazení stránky pro úpravu souboru Markdown se syntaxí pro všech šest úrovní nadpisů

Zobrazení náhledové stránky souboru Markdown se všemi šesti úrovněmi nadpisů

Úvod do GitHubu

Nadpisy

Zobrazení stránky pro úpravu souboru Markdown se syntaxí pro všech šest úrovní nadpisů]

Zobrazení náhledové stránky souboru Markdown se všemi šesti úrovněmi nadpisů a šipkami ukazujícími na linky pod nadpisy úrovně 1 a 2

Úvod do GitHubu

Formátování textu

Zobrazení stránky pro úpravu souboru Markdown se syntaxí pro tučný text a kurzívu

Zobrazení náhledové stránky souboru Markdown s tučným textem a kurzívou

Úvod do GitHubu

Hypertextové odkazy

Zobrazení stránky pro úpravu souboru Markdown se syntaxí pro hypertextový odkaz

Zobrazení náhledové stránky souboru Markdown s hypertextovým odkazem

Úvod do GitHubu

Hypertextové odkazy

Animované zobrazení kliknutí na hypertextový odkaz

Úvod do GitHubu

Obrázky

Animované zobrazení přetažení obrázku do souboru Markdown s automatickým vykreslením syntaxe GitHubem

Úvod do GitHubu

Psaní souboru README

  • Musí být popisný
    • Každý musí projektu rozumět
  • Uvádí obsah repozitáře
  • Jasně vysvětluje projekt ostatním

Ilustrace otevřené knihy

Úvod do GitHubu

Základy souboru README

  • Název
  • Popis technologií
    • Proč?
  • Popis postupu
    • Proč?
  • Obsah
Úvod do GitHubu

Doplňky souboru README

  • Vznik projektu
  • Motivace
  • Omezení
  • Výzvy
  • Jaký problém řeší
  • Zamýšlené použití
  • Poděkování
Úvod do GitHubu

Pojďme si procvičit!

Úvod do GitHubu

Preparing Video For Download...