Właśnie utworzyłem rozwidlenie projektu w Github, wprowadziłem zmiany itp. Zastanawiałem się: głównie widzę plik README. txt w projektach opensource, a edytowany przeze mnie plik to Readme.txt. Czy to jakiś rodzaj standaryzacji, czy powinienem zostawić go tak, jak jest?
Komentarze
- All-caps prawdopodobnie miał swój początek w MS-DOS wszystkie małe litery prawdopodobnie pochodzą z dziedzictwa unixowego. Nie jestem pewien co do pierwszej litery pisanej wielką literą – być może korzenie Maca. Ostatecznie nie ' nie ma to większego znaczenia, z wyjątkiem porządku lub stylu.
Odpowiedź
Wielkie litery wyróżniają się i sprawiają, że plik jest dobrze widoczny, co ma sens, ponieważ jest to prawdopodobnie pierwsza rzecz, na którą chciałby spojrzeć nowy użytkownik. (Lub przynajmniej powinien był spojrzeć na…) Jak powiedzieli inni, nazwy plików zaczynające się od dużej litery będą wymienione przed małymi literami w ASCIIbetical sortowanie (LC_COLLATE=C), które pomaga uczynić plik widocznym na pierwszy rzut oka.
README jest częścią zbioru plików, które użytkownik pakietu wolnego oprogramowania normalnie spodziewałby się znaleźć. Inne to INSTALL (instrukcje tworzenia i instalowania oprogramowania), AUTHORS (lista współpracowników), COPYING (tekst licencji), HACKING (jak zacząć współtworzyć, być może zawiera listę TODO punktów początkowych), NEWS (ostatnie zmiany) lub ChangeLog (w większości zbędne w przypadku systemów kontroli wersji).
Oto, co Standardy kodowania GNU mają do powiedzenia o pliku README.
Dystrybucja powinna zawierać plik o nazwie
READMEz ogólnym przeglądem pakietu:
- nazwa pakietu;
- numer wersji pakietu lub odnieś się do tego, gdzie w pakiecie można znaleźć wersję;
- ogólny opis tego, co robi pakiet;
- odniesienie do pliku
INSTALL, co powinno w tur n zawierać wyjaśnienie procedury instalacji;- krótkie wyjaśnienie wszelkich nietypowych katalogów lub plików najwyższego poziomu lub inne wskazówki dla czytelników, jak znaleźć sposób poruszania się po źródle;
- a odniesienie do pliku zawierającego warunki kopiowania. Jeśli jest używana, GNU GPL powinna znajdować się w pliku o nazwie
COPYING. Jeśli używana jest licencja GNU LGPL, powinna znajdować się w pliku o nazwieCOPYING.LESSER.
Ponieważ zawsze dobrze jest dążyć do jak najmniejszego zaskoczenia użytkowników, należy przestrzegać tej konwencji, chyba że istnieją istotne powody odstępstwa. W świecie UNIX rozszerzenia nazw plików były tradycyjnie używane oszczędnie, więc nazwa kanoniczna pliku to README bez żadnego sufiksu. Jednak większość użytkowników prawdopodobnie nie miałaby kłopotów ze zrozumieniem, że plik o nazwie README.txt ma to samo znaczenie. Jeśli plik jest zapisany w Markdown , nazwa pliku taka jak README.md może również być rozsądny. Unikaj jednak używania bardziej skomplikowanych języków znaczników, takich jak HTML w pliku README, ponieważ powinno być wygodne do czytania na terminalu tekstowym. Możesz wskazać użytkownikom podręcznik oprogramowania lub jego dokumentację online, która może być napisana w bardziej wyrafinowanym formacie, aby uzyskać szczegółowe informacje z pliku README.
Odpowiedź
Tradycyjnie plik nazywał się README wielkimi literami, ponieważ środowiska wiersza poleceń, które używają kolejności alfabetycznej, umieszczałyby plik na górze. Dzięki temu są łatwo widoczne w dużych katalogach.
Najprawdopodobniej jest to pozostałość ze świata Unix / Linux, w którym można pobrać źródła, a następnie zbudować oprogramowanie. Posiadanie plików takich jak README i INSTALL na górze widoku listy zawartości katalogu sprawia, że łatwiej zobaczyć, że tam są, zamiast przeglądać całą zawartość z poziomu interfejsu wiersza poleceń. Ta sama podstawowa zasada działa również w przypadku github (i faktycznie działa również w interfejsach GUI, pomyśl o tym, nadal ma zasługę)
W żadnym wypadku nie jest to twarda zasada, ale bardzo prawdopodobne, że wszyscy robią to z przyzwyczajenia, ponieważ robią to inne projekty. O ile nie ma wyraźnego powodu, aby NIE, prawdopodobnie powinieneś użyć wszystkich czapki tylko dlatego, że zobaczysz, że jest używany w ten sposób w wielu innych projektach. Jest to również domyślna nazwa, której Github używa podczas tworzenia nowego repozytorium.
Komentarze
- I ' zawsze uważałem, że wielkie litery są formą nacisku, podobnie jak w przypadku sekcji z wielkimi literami w języku prawniczym.
- W interfejsie wiersza poleceń pliki, które trafiają na górę listy, są w rzeczywistości tymi, które jako pierwsze są przewijane poza widokiem, więc czasami są to najmniej widoczne pliki. Chyba że zawsze robisz coś w rodzaju
ls -l | less.
Odpowiedz
README jest zwykle zapisywane dużymi literami. W ten sposób ls polecenie Unix umieściło plik w pobliżu początku listy katalogów (duże litery są przed małymi literami w kolejności ASCII).
Komentarze
- To był historyczny powód, ale
lsnie ' t zazwyczaj sortuj w ten sposób w nowoczesnych systemach. - @ dan1111 Racja! Dziękuję (wystarczy spróbować …
LC_COLLATE="en_US.ascii" ; ls -lvsLC_COLLATE="en_US.UTF-8" ; ls -l)