Crearea unui README

Introducere în conceptele GitHub

Jasmin Ludolf

Content Developer, DataCamp

Editarea README

Vizualizarea repository-ului de analiză fotbal

Introducere în conceptele GitHub

Editarea README

Vizualizarea repository-ului de analiză fotbal cu fișierul README evidențiat

Introducere în conceptele GitHub

Editarea README

Vizualizarea repository-ului de analiză fotbal cu pictograma creion pentru editarea README evidențiată

Introducere în conceptele GitHub

Markdown

Vizualizarea fișierului README

Introducere în conceptele GitHub

Editare vs. Previzualizare

Vizualizarea fișierului README cu filele de editare și previzualizare evidențiate

Introducere în conceptele GitHub

Titluri

Vizualizarea paginii de editare a unui fișier markdown cu sintaxa pentru titlul de nivel 1

Vizualizarea paginii de previzualizare a unui fișier markdown cu titlul de nivel 1

Introducere în conceptele GitHub

Titluri

Vizualizarea paginii de editare a unui fișier markdown cu sintaxa pentru toate șase tipuri de titluri

Vizualizarea paginii de previzualizare a unui fișier markdown cu toate șase tipuri de titluri

Introducere în conceptele GitHub

Titluri

Vizualizarea paginii de editare a unui fișier markdown cu sintaxa pentru toate șase tipuri de titluri]

Vizualizarea paginii de previzualizare cu toate șase tipuri de titluri și săgeți spre liniile de sub titlurile de nivel 1 și 2

Introducere în conceptele GitHub

Formatarea textului

Vizualizarea paginii de editare a unui fișier markdown cu sintaxa pentru bold și italic

Vizualizarea paginii de previzualizare a unui fișier markdown cu text bold și italic

Introducere în conceptele GitHub

Hyperlinkuri

Vizualizarea paginii de editare a unui fișier markdown cu sintaxa pentru un hyperlink

Vizualizarea paginii de previzualizare a unui fișier markdown cu un hyperlink

Introducere în conceptele GitHub

Hyperlinkuri

Vizualizare animată a unui clic pe un hyperlink

Introducere în conceptele GitHub

Imagini

Vizualizare animată a glisării unei imagini în fișierul markdown și randarea automată a sintaxei de către GitHub

Introducere în conceptele GitHub

Scrierea unui README

  • Trebuie să fie descriptiv
    • Oricine ar trebui să înțeleagă proiectul nostru
  • Listați conținutul repository-ului
  • Explică clar proiectul celorlalți

Ilustrație a unei cărți deschise

Introducere în conceptele GitHub

Elementele de bază ale README

  • Titlu
  • Descrierea tehnologiei
    • De ce?
  • Descrierea procesului
    • De ce?
  • Cuprins
Introducere în conceptele GitHub

Elemente suplimentare ale README

  • Cum a apărut proiectul
  • Motivația
  • Limitări
  • Provocări
  • Ce problemă încearcă să rezolve
  • Care este utilizarea intenționată
  • Credite
Introducere în conceptele GitHub

Să exersăm!

Introducere în conceptele GitHub

Preparing Video For Download...