W dzisiejszych czasach posiadanie dobrze napisanego pliku README.md na GitHubie jest kluczowe dla każdego projektu. README.md to pierwsze miejsce, które odwiedzają potencjalni użytkownicy, aby zrozumieć, o co chodzi w projekcie, jak go używać, i jakie są jego główne funkcje.

na stronie tusonic.pl/readme możesz stworzyć własny plik readme.md

Legenda:

Nagłówki są tworzone przy użyciu znaków #

• # Nagłówek 1 (najwyższy poziom nagłówka)
• ## Nagłówek 2
• ### Nagłówek 3
• #### Nagłówek 4
• ##### Nagłówek 5
• ###### Nagłówek 6 (najniższy poziom nagłówka)

Tekst pogrubiony i kursywa

• Pogrubienie: **tekst** lub __tekst__
• Kursywa: *tekst* lub _tekst_
• Pogrubiona kursywa: ***tekst*** lub ___tekst___

Listy

• Listy punktowane:
  • - Element listy
  • * Element listy
  • + Element listy
• Listy numerowane:
  • 1. Pierwszy element
  • 2. Drugi element
  • 3. Trzeci element

Linki

• Linki: [tekst linku](URL)
• Linki z tytułem: [tekst linku](URL "Tytuł linku")

Obrazy

• Obrazy: ![Alt tekst](URL do obrazu)

Kod

”’ kod ”’ (zamiast ’ daj ` )

Linie poziome

• Linie poziome: ---, *** lub ___