Readme.txt vs. README.txt (Română)

Literele majuscule ies în evidență și fac fișierul ușor vizibil, ceea ce are sens, deoarece este probabil primul lucru pe care un utilizator nou ar dori să-l privească. (Sau, cel puțin, ar fi trebuit să se uite la …) Așa cum au spus deja alții, numele fișierelor care încep cu majusculă vor fi listate înainte de numele cu litere mici în ASCIIbetical sortare (LC_COLLATE=C) care ajută la vizibilitatea fișierului la prima vedere.

README fișierul face parte dintr-o grămadă de fișiere pe care un utilizator al unui pachet software gratuit s-ar aștepta să le găsească în mod normal. Altele sunt INSTALL (instrucțiuni pentru construirea și instalarea software-ului), AUTHORS (lista contribuitorilor), COPYING (text licență), HACKING (cum să începeți să contribuiți, poate include o listă TODO a punctelor de pornire), NEWS (modificări recente) sau ChangeLog (în cea mai mare parte redundantă cu sistemele de control al versiunilor).

Aceasta este ceea ce GNU Coding Standards trebuie să spună despre fișierul README.

Distribuția trebuie să conțină un fișier numit README cu o prezentare generală a pachetului:

• numele pachetului;
• numărul versiunii pachetului sau consultați locul în care poate fi găsită versiunea;
• o descriere generală a ceea ce face pachetul;
• o referință la fișier INSTALL, care ar trebui să fie în tur n conțin o explicație a procedurii de instalare;
• o scurtă explicație a oricăror directoare sau fișiere de nivel superior neobișnuite sau alte indicii pentru ca cititorii să își găsească drumul în jurul sursei;
• a referință la fișierul care conține condițiile de copiere. GNU GPL, dacă este utilizat, ar trebui să fie într-un fișier numit COPYING. Dacă se folosește GNU LGPL, acesta ar trebui să fie într-un fișier numit COPYING.LESSER.

Deoarece este întotdeauna bine să te străduiești pentru cea mai mică surpriză a utilizatorilor tăi, ar trebui să urmezi această convenție, cu excepția cazului în care există motive imperioase pentru o abatere. În lumea UNIX, extensiile de nume de fișier erau folosite în mod tradițional, astfel încât numele canonic al fișierului este README fără sufix. Dar majoritatea utilizatorilor probabil nu ar avea probleme să înțeleagă că un fișier numit README.txt are același sens. Dacă fișierul este scris în Markdown , ar putea fi și un nume de fișier ca README.md rezonabil. Evitați totuși utilizarea limbajelor de marcare mai complicate precum HTML în fișierul README, deoarece ar trebui să fie convenabil să citiți pe un terminal numai text. Puteți indica utilizatorilor manualul software-ului sau documentația sa online, care ar putea fi scrisă într-un format mai sofisticat, pentru detalii din fișierul README.

În mod tradițional, fișierul se numea README cu majuscule, deoarece mediile din linia de comandă care utilizează ordonarea alfabetică ar pune fișierul în partea de sus. Acest lucru le face ușor vizibile în directoarele mari.

Cel mai probabil este o reținere din lumea Unix / Linux în care ați descărca surse și apoi vă veți construi software-ul. Dacă aveți fișiere precum README și INSTALL în partea de sus a vizualizării „conținutului directorului listei” îl faceți mai ușor de văzut că sunt acolo, în loc să trebuiască să răsfoiască întregul conținut dintr-o interfață din linia de comandă. Același principiu de bază funcționează și pentru github (și funcționează de fapt și în interfețele GUI, gândiți-vă la el, așa că s-ar putea încă nu merită)

În niciun caz o regulă dificilă, dar foarte probabil ceva pe care toată lumea îl face ca o obișnuință, deoarece alte proiecte o fac. Cu excepția cazului în care există un motiv explicit pentru care NU, probabil că ar trebui să folosiți toate majuscule doar pentru că veți vedea că este folosit în așa fel în multe alte proiecte. De asemenea, este denumirea implicită pe care o folosește Github atunci când creați un nou depozit.

Comentarii

• I ' am crezut întotdeauna că toate majusculele erau o formă de accentuare, la fel ca modul în care aveți secțiunile de majuscule în legalese.
• Într-o interfață din linia de comandă, fișierele care merg în partea de sus a listei sunt de fapt cele care derulează mai întâi din vizualizare, deci uneori acestea sunt fișierele cel mai puțin vizibile. Dacă nu faci întotdeauna ceva de genul ls -l | less.

README este de obicei scris cu majuscule. În acest fel, comanda ls Unix a plasat fișierul aproape de începutul listării directorului (literele majuscule vin înainte de literele mici în ordinea ASCII).

Comentarii

• Acesta a fost motivul istoric, dar ls nu ' t în mod obișnuit, sortați așa pe sistemele moderne.
• @ dan1111 Bine! Vă mulțumim (doar pentru a încerca … LC_COLLATE="en_US.ascii" ; ls -l vs LC_COLLATE="en_US.UTF-8" ; ls -l)