Co to jest plik README?
Plik readme to plik tekstowy, który jest często dołączany do oprogramowania i zawiera ogólne informacje lub instrukcje dotyczące oprogramowania. Specyfika tych informacji różni się znacznie w zależności od pliku; plik readme może zawierać instrukcje instalacji, ogólne informacje o użytkowaniu oprogramowania, warunki świadczenia usług i inne informacje prawne lub wszelkie inne informacje dotyczące oprogramowania. Prawie wszystkie pliki readme zawierają przynajmniej nazwę i wersję oprogramowania, nazwę firmy lub osoby, która opracowała oprogramowanie, oraz datę publikacji. Nie ma jednak ogólnej formuły na napisanie pliku readme, a ostatecznie treść zależy od kaprysów programisty.
Nazwa „readme” ma na celu zwrócić uwagę użytkownika na plik, ponieważ często zawiera informacje niezbędne do prawidłowego działania oprogramowania. W wielu przypadkach nazwa pliku readme będzie pisana wielkimi literami i będzie się nazywać „README.txt” lub coś podobnego. Niektóre katalogi programów przenoszą wielkie litery na górę dowolnej listy plików, więc wielkie litery wyróżniają plik readme i ponownie zachęcają użytkownika oprogramowania do przeczytania pliku przed użyciem programu. Niektóre pliki readme są w rzeczywistości zatytułowane „najpierw przeczytaj” lub coś podobnego, aby zachęcić czytelników do przejrzenia dokumentacji przed uruchomieniem oprogramowania.
Plik readme może zawierać wiele różnych rodzajów informacji o różnym znaczeniu. Oprócz nazw i wersji plików, które są zazwyczaj dołączane, pliki readme często zawierają również historię wersji lub dziennik zmian, który zawiera listę zmian wprowadzonych w oprogramowaniu w czasie. Plik Readme może również zawierać listę znanych problemów lub błędów, które wpływają na korzystanie z oprogramowania. Niektóre zawierają mniej istotne informacje, takie jak podziękowania lub osobiste wiadomości od zespołu programistów. W przypadku szczególnie prostych programów plik readme może faktycznie służyć jako instrukcja użytkownika, która instruuje użytkownika o ogólnym korzystaniu z oprogramowania.
Skomplikowane pliki readme są bardzo rzadkie, ponieważ programiści zazwyczaj wolą przedstawiać niezbędne informacje w prosty, jasny i zwięzły sposób. Plik readme jest zwykle prezentowany w formacie zwykłego tekstu ze standardową czcionką i bez obrazów, chyba że deweloper uzna, że konieczne jest coś bardziej skomplikowanego. Ta prostota usuwa niepotrzebne zakłócenia i utrzymuje czytelnika w skupieniu na informacjach. Czasami plik readme jest prezentowany w formacie „często zadawanych pytań” lub FAQ. W takim formacie programista przewiduje najczęstsze pytania dotyczące oprogramowania oraz podaje jasne i proste odpowiedzi zamiast przedstawiać wszystkie informacje techniczne w bloku tekstu, który ludzie nie powinni czytać.