Tworzenie pliku README

Wprowadzenie do GitHub – podstawowe pojęcia

Jasmin Ludolf

Content Developer, DataCamp

Edytowanie pliku README

Widok repozytorium soccer analysis

Edytowanie pliku README

Widok repozytorium soccer analysis z wyróżnionym plikiem README

Edytowanie pliku README

Widok repozytorium soccer analysis z wyróżnioną ikoną ołówka do edycji pliku README

Markdown

Widok pliku README

Edycja a podgląd

Widok pliku README z wyróżnionymi zakładkami edycji i podglądu

Nagłówki

Widok strony edycji pliku Markdown ze składnią dla największego nagłówka

Widok podglądu pliku Markdown z największym nagłówkiem

Nagłówki

Widok strony edycji pliku Markdown ze składnią dla wszystkich sześciu poziomów nagłówków

Widok podglądu pliku Markdown ze wszystkimi sześcioma poziomami nagłówków

Nagłówki

Widok strony edycji pliku Markdown ze składnią dla wszystkich sześciu poziomów nagłówków]

Widok podglądu pliku Markdown ze wszystkimi sześcioma poziomami nagłówków i strzałkami wskazującymi linie pod nagłówkiem pierwszego i drugiego poziomu

Formatowanie tekstu

Widok strony edycji pliku Markdown ze składnią dla pogrubienia i kursywy

Widok podglądu pliku Markdown z pogrubionym i pochylonym tekstem

Hiperłącza

Widok strony edycji pliku Markdown ze składnią hiperłącza

Widok podglądu pliku Markdown z hiperłączem

Hiperłącza

Animowany widok klikania hiperłącza

Obrazy

Animowany widok przeciągania obrazu do pliku Markdown i automatycznego renderowania składni przez GitHub

Pisanie pliku README

Musi być opisowy
- Każdy powinien rozumieć nasz projekt
Zawiera spis zawartości repozytorium
Jasno wyjaśnia projekt innym

Podstawy pliku README

Tytuł
Opis technologii
- Dlaczego?
Opis procesu
- Dlaczego?
Spis treści

Dodatkowe elementy README

Geneza projektu
Motywacja
Ograniczenia
Wyzwania
Problem do rozwiązania
Zamierzone zastosowanie
Podziękowania

Czas na ćwiczenia!

Wprowadzenie do GitHub – podstawowe pojęcia