README TUTORIAL

La breve guida che vado a presentarvi ora è una semplice raccolta di consigli su come creare un buon README file per le vostre creazioni revoltiane.
Ma innanzi tutto, cos'è un README?

Il file readme.txt è un semplicissimo file di testo (creato con il bloc notes) dove vengono riportate le informazioni importanti e sommarie che riguardano una determinata "aggiunta" o "modifica" di Revolt. Faccio un esempio pratico: avete appena creato una nuova pista, e volete pubblicarla su internet. E' bene che assieme alla vostra pista sia allegato anche un file README, dove viene specificato che quella pista è VOSTRA, che l'avete creata VOI, e che, insomma, VOI ne siete i proprietari.
Certo il file README non vi darà mai la certezza che qualcuno non "rubi" le vostre idee per distribuirle da altre parti. Ma ci si affida al comune rispetto del lavoro altrui, ed è in ogni caso più facile contestare un furto di materiale se assieme a questo era presente anche il suddetto file.txt.

Così come è importante segnalare chi è l'autore di quel determinato file (per definire così una specie di copyright), è altrettanto importante dichiarare chi è l'autore del file originale di partenza, se quello che si è appena costruito è una semplice modifica di qualcosa che esisteva già. Anche in questo caso, porto un esempio: se eseguo il repaint di un'auto di Manmountain, è importante che oltre al mio nome, nel file Readme, compaia anche quello di Manmountain! Questo per una tacita forma di stima nei confronti di chi ha lavorato prima di noi.

Oltre a questa importante segnalazione, visto che è espressamente richiesto da quasi tutti gli autori per tutte le loro creazioni, è importante ricordare che quando si modifica un lavoro eseguito da altri bisogna lasciare INTATTO E NON MODIFICATO il Readme del lavoro originale. Ad esempio, se io faccio un repaint di una pista di Hilaire9, oltre al readme dove risulta che IO ho eseguito il repaint, dovrà esserci anche il readme originale creato da Hilaire9.

Insieme alle informazioni riguardanti l'autore (FONDAMENTALI), nel Readme si possono inserire anche altre informazioni, come ad esempio i programmi e gli step utilizzati per arrivare alla creazione finale del file che l'utente ha appena scaricato.

Si possono poi aggiungere altri dati (lunghezza della pista, velocità dell'auto), oppure il sito/i siti dai quali si può scaricare il file in questione.

Quelli che vedete qui sotto sono 3 esempi di README che ho trovato in giro.

Readme scarso
Readme buono
Readme ottimo

Come potrete senz'altro notare voi stessi, il Readme valutato "scarso" è nettamente diverso da quelli valutati "buono" e "ottimo". Questo perchè il testo al suo interno ha una formattazione ridotta al minimo e pochissime informazioni (lunga descrizione, nessun dato tecnico, manca il nome dell'autore)

Le versioni "buono" e "ottimo" invece fanno già una figura decisamente diversa dal primo. I paragrafi sono formattati e con righe di separatori per rendere il tutto più ordinato. E' presente sia il nome dell'autore del file, sia quello della base di partenza. In più ci sono dati significativi sui programmi usati per costruire il file, nonché un elenco di altre creazioni delle stesso autore.

Come ultima nota, voglio dirvi che non è strettamente necessario prendere come esempio il readme definito Ottimo ed utilizzare sempre quello. Il Readme, così come la creazione a cui è accompagnato, è opera vostra. Definite quindi il vostro "stile", ed utilizzate sempre quello! E per dare un tocco di internazionalità in più, compilatelo in lingua inglese!