Polish description for potential GitHub users with a sample repository and the contents of the README.md file
- : 'Możesz dodać plik README do swojego repozytorium, aby powiedzieć innym ludziom, dla ktörych projekt jest przydatny, co mogą zrobić z tym projektem i jak mogą go używać.'
Możesz dodać plik README do repozytorium, aby przekazać ważne informacje o projekcie. README, wraz z repozytorium licencją , wytyczne wkładu i kod postępowania , i wytyczne wkładu , komunikuje oczekiwania na projekt i pomaga zarządzać wkładami.
Aby uzyskać więcej informacji na temat dostarczania wytycznych dotyczących projektu, zobacz "Dodawanie kodu postępowego do projektu" i "Konfigurowanie projektu dla zdrowego wkładu".
Spis treści
Automatycznie-wygenerowany spis treści do plików README
Łącza do sekcji w plikach README i stronach obiektów blob
Względne łącza ścieżki do obrazów w plikach README
Dalsze zagadnienia
Plik README, wraz z licencją na repozytorium , wytycznymi dotyczącymi wkładu i kodeksem postępowania , pomaga w komunikowaniu oczekiwań dotyczących wkładu do projektu i zarządzaniu nim.
README jest często pierwszym elementem, który goście zobaczą podczas odwiedzania Twojego repozytorium.
Pliki README zwykle zawierają informacje na temat:
- Co robi projekt
- Dlaczego projekt jest przydatny
- Jak użytkownicy mogą rozpocząć pracę z projektem
- Gdzie użytkownicy mogą uzyskać pomoc dotyczącą projektu
- Kto zajmuje się projektem i wnosi wkład w projekt
Jeśli umieścisz plik README w katalogu głównym repozytorium, docs lub ukryty katalog .github, GitHub rozpozna i automatycznie wyświetli plik README odwiedzającym repozytorium.
Jeśli dodasz plik README do katalogu głównego repozytorium publicznego o takiej samej nazwie co nazwa użytkownika, ten plik README automatycznie pojawi się na stronie profilu. Możesz edytować swój profil README z GitHub Markdown, aby utworzyć spersonalizowaną sekcję w swoim profilu. Aby uzyskać więcej informacji, zobacz "Zarządzanie swoim profilem README".
W przypadku renderowanego widoku dowolnego pliku Markdown w repozytorium, w tym pliku README, GitHub automatycznie generuje spis treści na podstawie nagłówków sekcji. Możesz przeglądać spis treści dla pliku README, klikając ikonę
Auto-generowany spis treści jest domyślnie włączony dla wszystkich plików Markdown w repozytorium, ale możesz wyłączyć tę funkcję do repozytorium.
- Na GitHub przejdź do strony głównej.
- W ramach nazwy repozytorium kliknij ☸️ Ustawienia.
- W obszarze "Funkcje" odznaczyć Spis treści.
Wiele projektów używa spisu treści na początku pliku README, aby skierować użytkowników do różnych sekcji pliku. Możesz utworzyć łącze bezpośrednio do sekcji w wyrenderowanym pliku, umieszczając wskaźnik myszy nad nagłówkiem sekcji, aby wyświetlić łącze:
Możesz zdefiniować linki względne i ścieżki obrazów w renderowanych plikach, aby ułatwić czytelnikom nawigację do innych plików w repozytorium. Względne łącze to łącze względne w stosunku do bieżącego pliku. Na przykład, jeśli masz plik README w katalogu głównym repozytorium i masz inny plik w docs/CONTRIBUTING.md, względne łącze do CONTRIBUTING.md w pliku README może wyglądać tak:
[Wytyczne dotyczące wkładu dla tego projektu](docs/CONTRIBUTING.md)
GitHub automatycznie przekształci Twoje względne łącze lub ścieżkę obrazu w oparciu o gałąź, w której aktualnie się znajdujesz, tak aby łącze lub ścieżka zawsze działały. Możesz użyć wszystkich względnych operandów linków, takich jak ./ i ../ .
Względne linki są łatwiejsze dla użytkowników, którzy klonują Twoje repozytorium. Łącza bezwzględne mogą nie działać w klonach repozytorium - zalecamy używanie odnośników względnych do odwoływania się do innych plików w repozytorium.