Co to jest format pliku README?
Plik .readme to plik dokumentacji w formacie czystego tekstu (plain-text), zgodny z konwencją README wywodzącą się z systemów Unix i kultury oprogramowania open-source. Rozszerzenie .readme jest rzadziej spotykanym wariantem tradycyjnych form, takich jak pisane wielkimi literami README (bez rozszerzenia) oraz README.txt.
Pliki README dostarczają czytelną dla człowieka dokumentację wstępną dla pakietu oprogramowania, projektu lub archiwum. Typowa zawartość obejmuje opis projektu, instrukcje instalacji i użytkowania, informacje o autorze oraz powiadomienie o licencji. Nie istnieje żadna obowiązkowa struktura - treść to dowolna proza i listy.
Zapis README wielkimi literami bez rozszerzenia datuje się co najmniej na lata 70. XX wieku w dystrybucjach Unix, gdzie konwencjonalnie był to pierwszy plik, który użytkownik powinien przeczytać; menedżery pakietów i listingi katalogów często wyświetlały go automatycznie. README.txt stał się powszechny w systemie Windows. Od około 2008 roku dominującą formą stał się README.md (Markdown), ponieważ GitHub automatycznie renderuje Markdown na stronach repozytoriów.
Rozszerzenie .readme jest sporadycznie spotykane w starszych dystrybucjach shareware i niektórych menedżerach pakietów, ale nie niesie ze sobą żadnych technicznych różnic w stosunku do .txt - oba są czystym tekstem, który każdy edytor otwiera bez dodatkowej konfiguracji. Kodowanie to zazwyczaj UTF-8 (nowoczesne) lub ASCII (starsze); narzędzia Windows mogą tworzyć pliki UTF-16 LE z BOM, ale standardem jest UTF-8. Rozmiar pliku prawie zawsze wynosi poniżej 100 KB.
Bezpieczeństwo
RYZYKO: LOWPlik tekstowy; brak kodu wykonywalnego; całkowicie bezpieczny do otwarcia w dowolnym edytorze tekstu.
Szczegóły formatu
w pigułceProgramy otwierające pliki README
Windows3 apps
Windows Notepad
Wbudowany Podwójne kliknięcie może nie zadziałać (system może nie rozpoznać rozszerzenia .readme); kliknij prawym przyciskiem myszy → Otwórz za pomocą → Notatnik. 
Notepad
Open-source Kliknij prawym przyciskiem myszy → Otwórz za pomocą → Notepad++; lub przeciągnij plik do okna Notepad++. 
Visual Studio Code
Open-source Plik → Otwórz plik, wybierz plik .readme; wyświetla się jako czysty tekst. 
macOS2 apps
Visual Studio Code
Open-source Plik → Otwórz plik, wybierz plik .readme; wyświetla się jako czysty tekst. 
Linux2 apps
Szczegóły techniczne
specyfikacja| Kodowanie | UTF-8 (nowoczesny standard); ASCII (starsze); sporadycznie UTF-16 LE z BOM w systemie Windows |
| Kontener | Czysty tekst - brak binarnego opakowania, nagłówka czy schematu |
| Obowiązkowa struktura | Brak - dowolna proza; brak zdefiniowanych pól lub wymaganej kolejności |
| Typowe warianty nazw plików | README (bez rozszerzenia), README.txt, README.md, .readme |
| Typ MIME | text/plain |
| Typowy rozmiar pliku | Prawie zawsze poniżej 100 KB |
| Końce linii | LF (Unix/macOS/Linux) lub CRLF (Windows); oba akceptowane przez edytory tekstu |
| UTF-8 BOM | Opcjonalny - możliwy w plikach utworzonych w Windows (prefiks EF BB BF) |
| Dominująca nowoczesna forma | README.md (Markdown), automatycznie renderowany przez GitHub, GitLab i Bitbucket od ok. 2008 roku |
| Historyczne wyświetlanie | Wyświetlany automatycznie przez wczesne listingi katalogów Unix i menedżery pakietów |
| Powiązane platformy | Wszystkie systemy operacyjne - Windows, macOS, Linux, Unix |
| Typowa zawartość | Opis projektu, instrukcje instalacji/użytkowania, informacje o autorze, powiadomienie o licencji |
| Wydano | 1970s Unix tradition; .readme as a distinct extension less common than plain README or README.txt |
| Najnowsza wersja | N/A - no versioning |
| Otwarty standard | Tak · bezpłatny (royalty-free) |
Konwersje README
Pytania i odpowiedzi społeczności
pytania użytkownikówBrak pytań - bądź pierwszą osobą, która zapyta o pliki README.
