Właśnie rozwidliłem projekt w Github, wprowadziłem zmiany itp. To mnie zastanowiło: w projektach typu open source widzę głównie README.txt, a edytowany przeze mnie plik to Readme.txt. Czy to jest jakaś standaryzacja, czy powinienem ją zostawić taką, jaka jest?
naming-standards
Tolga Ozses
źródło
źródło
Odpowiedzi:
Wielkie litery wyróżniają się i sprawiają, że plik jest dobrze widoczny, co ma sens, ponieważ jest to prawdopodobnie pierwsza rzecz, na którą nowy użytkownik chciałby spojrzeć. (Lub przynajmniej powinien był spojrzeć na ...) Jak już powiedzieli inni, nazwy plików zaczynające się od dużej litery będą wyświetlane przed małymi literami w sortowaniu ASCIIbetical (
LC_COLLATE=C
), co pomaga sprawić, by plik był widoczny na pierwszy rzut oka.README
Plik jest częścią pęczek plików użytkownik darmowego pakietu oprogramowania normalnie oczekiwać. Inne toINSTALL
(instrukcje budowania i instalowania oprogramowania),AUTHORS
(lista współtwórców),COPYING
(tekst licencji),HACKING
(jak zacząć pisać, może zawierać listę punktów początkowych TODO),NEWS
(ostatnie zmiany) lubChangeLog
(głównie zbędne z systemy kontroli wersji).Oto, co na temat pliku mają do powiedzenia standardy kodowania GNU
README
.Ponieważ zawsze warto dążyć do najmniejszej niespodzianki dla użytkowników, należy postępować zgodnie z tą konwencją, chyba że istnieją istotne powody odchylenia. W świecie UNIX rozszerzenia nazw plików były tradycyjnie używane oszczędnie, więc kanoniczna nazwa pliku
README
nie zawiera żadnego przyrostka. Ale większość użytkowników prawdopodobnie nie miałaby problemów ze zrozumieniem, że nazwany plikREADME.txt
ma takie samo znaczenie. Jeśli plik jest zapisany w Markdown , nazwa plikuREADME.md
może być również uzasadniona. Unikaj używania bardziej skomplikowanych języków znaczników, takich jak HTML, wREADME
plik, ponieważ powinien być wygodny do czytania na terminalu tekstowym. Możesz wskazać użytkownikom instrukcję oprogramowania lub jego dokumentację online, które mogą być napisane w bardziej wyrafinowanym formacie, w celu uzyskania szczegółowych informacji zREADME
pliku.źródło
Tradycyjnie plik nazywał się README dużymi literami, ponieważ środowiska wiersza poleceń korzystające z porządku alfabetycznego umieszczałyby plik na górze. Dzięki temu są łatwo widoczne w dużych katalogach.
Najprawdopodobniej jest to pozostałość po świecie 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 „zawartość katalogu listy” ułatwia zobaczenie, ż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, przyjdź i pomyśl o tym, aby nadal mieć wartość)
W żadnym wypadku nie jest to twarda zasada, ale bardzo prawdopodobne, że wszyscy robią to jako nawyk, ponieważ robią to inne projekty. O ile nie ma wyraźnego powodu, by tego NIE robić, prawdopodobnie powinieneś używać wszystkich wielkich liter tylko dlatego, że zobaczysz, że jest to używane w wielu innych projektach. Jest to również domyślne nazewnictwo używane przez Github podczas tworzenia nowego repozytorium.
źródło
ls -l | less
.Plik README jest zwykle pisany wielkimi literami. W ten sposób
ls
polecenie uniksowe umieściło plik w pobliżu początku listy katalogów (wielkie litery pojawiają się przed małymi literami w porządku ASCII).źródło
ls
zwykle nie sortuje się tak w nowoczesnych systemach.LC_COLLATE="en_US.ascii" ; ls -l
vsLC_COLLATE="en_US.UTF-8" ; ls -l
)