Readme.txt vs. README.txt (Italiano)

Le lettere tutte maiuscole risaltano e rendono il file facilmente visibile, il che ha senso perché è probabilmente la prima cosa che un nuovo utente vorrebbe guardare. (O, almeno, avrebbe dovuto aver esaminato …) Come altri hanno già detto, i nomi dei file che iniziano con una lettera maiuscola verranno elencati prima dei nomi minuscoli in ASCIIbetical (LC_COLLATE=C) che aiuta a rendere il file visibile a prima vista.

Il README file fa parte di un gruppo di file che un utente di un pacchetto software gratuito normalmente si aspetterebbe di trovare. Altri sono INSTALL (istruzioni per la creazione e linstallazione del software), AUTHORS (elenco di collaboratori), COPYING (testo della licenza), HACKING (come iniziare a contribuire, magari includendo un elenco TODO di punti di partenza), NEWS (modifiche recenti) o ChangeLog (per lo più ridondante con i sistemi di controllo della versione).

Questo è ciò che Gli standard di codifica GNU hanno da dire sul file README.

La distribuzione dovrebbe contenere un file denominato README con una panoramica generale del pacchetto:

• il nome del pacchetto;
• il numero di versione del pacchetto, o fare riferimento a dove si trova la versione nel pacchetto;
• una descrizione generale di ciò che fa il pacchetto;
• un riferimento al file INSTALL, che dovrebbe essere tur n contengono una spiegazione della procedura di installazione;
• una breve spiegazione di qualsiasi directory o file insolito di primo livello, o altri suggerimenti per i lettori per orientarsi nei sorgenti;
• a riferimento al file che contiene le condizioni di copia. La GNU GPL, se usata, dovrebbe essere in un file chiamato COPYING. Se viene utilizzato GNU LGPL, dovrebbe essere in un file chiamato COPYING.LESSER.

Poiché è sempre bene sforzarsi per la minima sorpresa dei tuoi utenti, dovresti seguire questa convenzione a meno che non ci siano motivi convincenti per una deviazione. Nel mondo UNIX, le estensioni dei nomi dei file erano tradizionalmente usate con parsimonia, quindi il nome canonico del file è README senza alcun suffisso. Ma la maggior parte degli utenti probabilmente non avrebbe problemi a capire che un file chiamato README.txt ha lo stesso significato. Se il file è scritto in Markdown , potrebbe essere anche un nome file come README.md ragionevole. Evita tuttavia di utilizzare linguaggi di markup più complicati come HTML nel file README, perché dovrebbe essere comodo da leggere su un terminale di solo testo. È possibile indirizzare gli utenti al manuale del software o alla sua documentazione in linea, che potrebbe essere scritta in un formato più sofisticato, per i dettagli dal file README.

Tradizionalmente il file era chiamato README in maiuscolo perché gli ambienti della riga di comando che utilizzano lordine alfabetico avrebbero quindi messo il file in cima. Questo li rende facilmente visibili in grandi directory.

È molto probabile che sia un residuo del mondo Unix / Linux in cui scaricheresti i sorgenti e poi creeresti il tuo software. Avere file come README e INSTALL nella parte superiore della tua visualizzazione “elenco dei contenuti della directory” lo rende più facile vedere che sono lì, invece di dover sfogliare lintero contenuto da uninterfaccia a riga di comando. Lo stesso principio di base funziona anche per GitHub (e in realtà funziona anche nelle interfacce GUI, a pensarci bene, quindi potrebbe ha ancora un merito)

Non è assolutamente una regola rigida, ma molto probabilmente qualcosa che tutti fanno come unabitudine perché altri progetti lo stanno facendo. A meno che non ci sia qualche ragione esplicita per NON farlo, probabilmente dovresti usare tutto tappi solo perché vedrai che viene utilizzato in questo modo in molti altri progetti. È anche la denominazione predefinita utilizzata da Github quando crei un nuovo repository.

Commenti

• I ' ho sempre pensato che tutto maiuscolo fosse una forma di enfasi, molto simile a come hai le parti maiuscole in legalese.
• Su uninterfaccia a riga di comando, i file che vanno allinizio dellelenco sono in realtà quelli che scorrono per primi fuori dalla visualizzazione, quindi a volte questi sono i file meno visibili. A meno che tu non faccia sempre qualcosa del tipo ls -l | less.

README è solitamente scritto in maiuscolo. In questo modo il comando ls Unix ha posizionato il file vicino allinizio dellelenco delle directory (le lettere maiuscole vengono prima delle lettere minuscole nellordine ASCII).

Commenti

• Questo era il motivo storico, ma ls non ' in genere ordina in questo modo sui sistemi moderni.
• @ dan1111 Giusto! Grazie (solo per provare … LC_COLLATE="en_US.ascii" ; ls -l vs LC_COLLATE="en_US.UTF-8" ; ls -l)