Olen juuri haarautunut projektiin Githubissa, tehnyt muutokseni jne. Tämä sai minut miettimään: näen enimmäkseen README. txt opensource -projekteissa ja muokkaamani tiedosto oli Readme.txt. Onko tämä jonkinlainen standardisointi vai pitäisikö minun jättää se sellaisena kuin se on?
Kommentit
- All-caps aloitti todennäköisesti MS-DOS: ssa, kaikki pienet kirjaimet luultavasti unix-perinnöstä. Etkö ole varma isoista kirjaimista – ehkä Mac-juuret. Loppujen lopuksi sillä ei ole ' merkitystä, paitsi siisteydestä tai tyylistä.
Vastaa
Kaikki isot kirjaimet erottuvat ja tekevät tiedostosta helposti näkyvän, mikä on järkevää, koska se on todennäköisesti ensimmäinen asia, jonka uusi käyttäjä haluaa tarkastella. (Tai ainakin olisi pitänyt tarkastella…) Kuten muut ovat jo sanoneet, isoilla kirjaimilla alkavat tiedostonimet luetellaan ennen pieniä kirjaimia ASCIIbetical -lajittelu (LC_COLLATE=C), joka auttaa tiedostoa näkymään ensi silmäyksellä.
README -tiedosto on osa joukkoa tiedostoja, jotka ilmaisen ohjelmistopaketin käyttäjä yleensä odottaa löytävänsä. Toiset ovat INSTALL (ohjeet ohjelmiston rakentamiseen ja asentamiseen), AUTHORS (avustajien luettelo), COPYING (lisenssiteksti), HACKING (miten aloittaa osallistuminen, mahdollisesti sisällyttämällä TODO-luettelo lähtökohdista), NEWS (viimeisimmät muutokset) tai ChangeLog (enimmäkseen tarpeeton versionhallintajärjestelmien kanssa).
Tätä GNU-koodausstandardit on sanottava README -tiedostosta.
Jakelun tulee sisältää tiedosto nimeltä
READMEja yleiskatsaus paketista:
- paketin nimi;
- paketin versionumero tai viittaus siihen, mistä paketissa versio löytyy;
- yleiskuvaus paketin toiminnasta;
- viittaus tiedostoon
INSTALL, jonka pitäisi olla tur n sisältää selityksen asennusprosessista;- lyhyt selitys epätavallisista ylätason hakemistoista tai tiedostoista tai muita vinkkejä lukijoiden selville lähteestä;
- a viittaus tiedostoon, joka sisältää kopiointiehdot. Jos sitä käytetään, GNU GPL: n tulisi olla tiedostossa nimeltä
COPYING. Jos käytetään GNU LGPL: ää, sen pitäisi olla tiedostossa nimeltäCOPYING.LESSER.
Koska on aina hyvä pyrkiä käyttäjien pienimpään yllätykseen, noudata tätä käytäntöä, ellei poikkeamalle ole pakottavia syitä. UNIX-maailmassa tiedostojen nimilaajennuksia käytettiin perinteisesti säästeliäästi, joten tiedoston kanoninen nimi on README ilman loppuliitettä. Mutta useimmilla käyttäjillä ei todennäköisesti ole ongelmia ymmärtää, että README.txt -nimisellä tiedostolla on sama merkitys. Jos tiedosto on kirjoitettu Markdown , tiedostonimi kuten README.md saattaa olla kohtuullinen. Vältä monimutkaisempien merkintäkielien, kuten HTML, käyttöä README -tiedostossa, koska sen pitäisi olla kätevää lukea vain tekstipäätteellä. Voit osoittaa käyttäjille ohjelmiston käyttöohjeen tai sen online-ohjeet, jotka voidaan kirjoittaa kehittyneemmässä muodossa, saadaksesi lisätietoja README -tiedostosta.
vastaus
Perinteisesti tiedostoa kutsuttiin README-kirjaimeksi isoilla kirjaimilla, koska aakkosjärjestystä käyttävät komentoriviympäristöt asettaisivat tiedoston sitten ylhäältä. Tämä tekee niistä helposti näkyvissä isoissa hakemistoissa.
Se on todennäköisesti pidätin Unix / Linux-maailmasta, josta voit ladata lähteitä ja sitten rakentaa ohjelmistosi. Jos sinulla on tiedostoja README ja INSTALL luetteloluettelon sisällön yläosassa, se tekee siitä on helpompi nähdä, että ne ovat siellä sen sijaan, että sinun tarvitsisi selata koko sisältöä komentoriviltä. Sama perusperiaate toimii myös githubissa (ja toimii myös GUI-käyttöliittymissä, miettiä sitä, joten se saattaa edelleen ansioita)
Ei suinkaan kovaa sääntöä, mutta todennäköisesti jotain, mitä kaikki tekevät tapana, koska muut projektit tekevät sen. Ellei ole nimenomaista syytä EI, sinun pitäisi todennäköisesti käyttää kaikkia caps vain siksi, että huomaat sen käyttävän tällä tavalla monissa muissa projekteissa. Se on myös oletusnimi, jota Github käyttää uuden arkiston luomisessa.
Kommentit
- I ' ve ovat aina ajatelleet, että kaikki isot kirjaimet ovat eräänlainen painopiste, aivan kuten se, miten isot kirjaimet ovat legaleseina.
- Komentoriviliittymässä luettelon yläosaan menevät tiedostot vierivät ensin näkyvistä, joten joskus nämä ovat vähiten näkyviä tiedostoja. Ellet tee aina jotain esimerkiksi
ls -l | less.
Vastaa
README kirjoitetaan yleensä isoilla kirjaimilla. Tällä tavalla ls Unix-komento sijoitti tiedoston lähelle hakemistoluettelon alkua (isot kirjaimet ovat pieniä kirjaimia edeltäviä ASCII-järjestyksessä).
Kommentit
- Tämä oli historiallinen syy, mutta
lsei ' t lajitellaan tyypillisesti tällä tavalla nykyaikaisissa järjestelmissä. - @ dan1111 Aivan! Kiitos (vain kokeilla …
LC_COLLATE="en_US.ascii" ; ls -lvsLC_COLLATE="en_US.UTF-8" ; ls -l)