Cartesian School CartesianSchool
Python od zera / Rozdział 23 / README
Rozdział 23 · Część III · Tworzymy projekt Python-

Pierwszy README projektu

README odpowiada na pytania "co to jest?" i "jak zacząć?" jeszcze zanim ktoś otworzy kod.

SafeSort · Część 3 z 6Projekt
safesort/
.git/
README.mdNOWE
README.md — jeden z plików startowego commita, widzianego w poprzedniej sekcji.

README — pierwszy plik, który widzi osoba, otwierając repozytorium: GitHub automatycznie pokazuje jego zawartość na stronie głównej projektu. W sklonowanym repozytorium README.md już istnieje i jest już zatwierdzony — to część początkowego commita chore: initial project scaffoldto pokazano w poprzednim sekcję. Teraz jest bardzo krótki:

README.md
# SafeSort

SafeSort — программа для безопасной сортировки файлов по папкам.

Ponieważ plik jest już śledzony przez Git, git status w czystej pracy nie pokaże nic drzewu — nie ma nic do dodania ani nic do zobowiązania. Ciekawe zacznie się wtedy Zmiany zostaną wprowadzone w pliku: tak README rośnie w trakcie rozdziału – jest uzupełniany sekcjami, i nie przepisywana od zera. Dodajmy pierwszą taką sekcję:

README.md
# SafeSort

SafeSort — программа для безопасной сортировки файлов по папкам.

## Instalacja

pip install -e .
~/safesort $ git diff
diff --git a/README.md b/README.md
index f5a2610..d60da39 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,7 @@
# SafeSort
SafeSort program do bezpiecznego sortowania plików w folderach.
+
+## Instalacja
+
+pip install -e .
~/safesort $ git status
M README.md

git diff pokazuje różnice linia po linii przed zatwierdzeniem, git status — co dokładnie zmieniło się od ostatniego zatwierdzenia. W miarę pojawiania się w projekcie instalacji, komend i testów, w README dodadzą się takie same krótkie sekcje Usage i Tests. Pełny README projektu, już uzupełniony: projects/python/safesort/README.md.

Bez wymyślonych ikon
Na stronie projektu na GitHub czasami pojawiają się kolorowe ikony (badge) rodzaju „tests: passing”). Taka ikona jest prawdziwa tylko wtedy, gdy naprawdę obsługuje ją skonfigurowany sprawdzian — wrócimy do tego, gdy podłączymy GitHub Actions. Wstawianie jej wcześniej oznacza pokazywanie czegoś, czego faktycznie jeszcze nie ma.

Krótko

  • README.md — pierwsze, co widzi człowiek, który otworzył repozytorium na GitHub.
  • README można dodawać w miarę rozwoju projektu, zamiast pisać wszystko za pierwszym razem.
  • git diff pokazuje zmiany linijka po linijce git status pokazuje, które pliki są dotknięte.
← Back
Repozytorium projektu