Home    Forum    Cerca    FAQ    Iscriviti    Login
Nascondi Menu Principale
  Community
Readme
Readme Inviato il  Gio 19 Mag, 2011 14:35 Da TheFactor82
Tutorials
La breve guida che vado a presentarvi è una semplice raccolta di consigli su come creare un buon file README (in italiano LEGGIMI) per le vostre creazioni revoltiane.
Ma innanzi tutto, cos'è un README?

Il file readme.txt è un semplicissimo file di testo (creato con il Blocco Note ed in formato TXT - attenzione a non utilizzare formati di testo diversi. Un readme fatto con Word e salvato come DOC o come qualsiasi altra cosa diversa dal TXT non raggiungerebbe lo scopo di poter essere letto su QUALSIASI piattaforma) 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.

Riporto qui 3 esempi presi da Readme reali.

Codice: [Nascondi] [Seleziona]
[Updated] A slight acceleration boost and a bit more grip to the rear to try to improve stability when using the battery power-up.[Updated]

The Mule

The Mule is a car born out of necessity. When I first started to play Re-Volt I had a hard time controling the cars. The only car that I was able to controle with any bit of ease was Beatall.(Dr. Grunge ..er.. something) fortunitly it also hapend to be the car I thought was the coolest. After about a week I had made it all the way up to the platum championship leval using beatall. But once there the grate handaling of the car wasn't enough to compete with the pro cars. In my search for a new car, not caring much for the newly unlocked cars either, I ended up at the great site of Re-Volt HQ and began downloading new shipments of cars.

Just having many new cars was great but most didn't handle anywhere near what I was looking for. Some didn't handle at all. others, like the burnning, where way to capible. Then other were just about right, like ferrari and Kail. But even those semmed to be missing something. I realised that to get what I wanted I would have to make it my self. A car with shocks like betall but that can handel higher speeds. a car that handles well and not overly powerfull.

I started with beatall and tested it and every car the had something about it I liked. I slowly began to figure out what the diferant settings do and tested some more. I changed the body of the car(the T-tops look great) and tested some more. Less than a week after I started(a sleepless week at that) I was done; then tested some more. The only thing that The Mule has that hasn't been changed from beatall is the body shape.(I don't own a 3D graphics program)

What I ended up with was a cool car that handles like a dream.
Acceleration slow, but this is a good thing.Makeing it easyer to controle through tight
sections.It also helps to balance out it's capibilities
Top speed High, But not too high and it takes a while to get there.
Deceleratiom High, One of it's best features.Makes it more like driving it than
controling it
skidding turns High, very easy to controle through a skid with throttel and wheeles
Non skid turns High, The first time you decelerate then go throght a windy section you'll
know
stability High, I had to increce the sability because most of the fast cars are
lowbody cars and would cause this open wheel giant to flip too easily. This car is also a dream to drive through bumpy sections of track
jumping High, For it's speed it goes a little less the distance than other cars but
it's shocks and stability make jumps smooth as silk


Questo ad esempio non si può dire che sia un buon readme. Si può notare che il testo al suo interno ha una formattazione ridotta al minimo e sono poche le informazioni fornite (lunga descrizione, nessun dato tecnico).
Cosa importantissima e, in questo caso, gravissima: manca il nome dell'autore!


Codice: [Nascondi] [Seleziona]
================================================================
Car name : RV-C 01
Install in folder : Re-volt\cars\RVC01
Author : PierreZ
Email Address : pierre_ziegler@hotmail.com
Misc. Author Info :

Description : this is the first car I entirelly made (I mean mesh & paint).
this car was made in 3DSmax. It is any car in particular.
Waiting for your comments.

Additional Credits to : First of all I'd like to thanks Scloink for telling me that
rvtmod4 do exist ;)... As a consequence thx to Ali and Morph for
this tool. Thx too to all cars makers and tracks makers
who made this game became wonderful.
================================================================

* Play Information *

Top speed (observed) : 56mph
Rating : Pro

* Construction *

Base : New mesh.
Editor(s) used : 3DSmax-R3, Adobe photoshop 5.0, Microsoft Paint.
Known Bugs : 4 very little polys haven't been correctly textured. But it is
any real bug and it is not specialy visible.


* Copyright / Permissions *

Authors MAY use this Car as a base to build additional
cars. Just quote me in your readme, please.

You may distribute this file in any electronic format
(BBS, Diskette, CD, etc) as long as you include this file
intact.


* Where to get this CAR *

Website :
http://www.racerpoints.com/revolt

* Other cars by PierreZ *

01- cdlabomb (high speed, great control)
02- gamin (the little sister of cdlabomb. less speed)
03- TR9 (the look and the name of my ski shoes!)
04- estrelia Z210 (boarf. easy to drive. nothing to say)
05- marie (my favorite ;). You know why???)
06- peugeot406 (i really think the look is like the real car. great speed and control)
07- 406original (another color for the 1998 model of the 406)
08- rally406 (really like it)
09- toyota Corolla Classic (interesting to drive)
10- AC Aston Martin DB7 (an AC cobra look on a DB7. great speed and control)
11- police 50's (i found funny to make this one. great speed and control)
12- red one (a viper touch (lights) for this toyeca with great speed and control)

those cars can be get on:
http://www.revolthq.com
http://rvtt.free.fr


Questo è un readme di buon livello.


Codice: [Nascondi] [Seleziona]
================================================================
Car name : Ford GT40
Install in folder : Unzip in your Revolt folder.
Authors : Conversion by PierreZ of a model from BUTCH
Email Addresses : pierrez76@hotmail.com
Additional Credits to : BUTCH for the beautiful model under NFS4.
You for downloading this car.
RVA and Racerpoints!!!
================================================================
This car has 5 differents skins. Just run the bat file with
the name of the wanted color and it will be OK.
================================================================
Construction
----------------------------------------------------------------
Base : Ford GT40 by BUTCH for NFS4.
(http://www.kcendra.com/nfsbolide/)
Editor (s) used : max, ps4, mspaint, notepad, rvtmod4...
Known Bugs : None
================================================================
Copyright / Permissions
----------------------------------------------------------------
Authors MAY use this Car as a base to build additional
cars. Just quote BUTCH and me in your readme, please.
You may distribute this file in any electronic format
(BBS, Diskette, CD, etc) as long as you include this file
intact.
================================================================
Where to get this CAR
----------------------------------------------------------------
http://www.rvarchive.com/
http://rvpz.free.fr/
----------------------------------------------------------------
Other CUSTOM cars by PierreZ
(available on http://rvpz.free.fr)
----------------------------------------------------------------
01- RV-C 01
02- RV-C 02
03- Audi TT
04- Avantime
05- Alpine A110
06- Lamborghini MIURA 1968
07- Dino 246 GT
08- Porsche 911 GT3
09- Dax Rush
10- Corvette TTOP 1969
11- Ford GT40
----------------------------------------------------------------
In (very low...) progress
----------------------------------------------------------------
Ferrari 365 GTB4
Detomaso Mangusta
McLaren M6 BGT
Maserati Ghibli
Aston Martin DBS
...
----------------------------------------------------------------
If your interested in the parameters creation for those cars,
e-mail me: pierrez76@hotmail.com


Questo infine è un OTTIMO readme

Le versioni "buono" e "ottimo" fanno 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.

Fondamentalmente la differenza tra il readme buono e quello ottimo è che l'ultimo è un po' più sintetico del precedente. Questo è molto importante perchè la persona che lo legge non deve perderci troppo tempo.

Come ultima nota, 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 (o sia in italiano che in inglese)!


 

Commenta questa notizia Stampa l'argomento Segnala via email l'argomento
Questa notizia ha  2147 Visualizzazioni e 0 Commenti
Nascondi Menu Tutorials & Manuali
  Tutorials
  Manuali

 



Copyright (C) 2000 - 2014 AliasReVoltMaster.com
Tutti i diritti riservati

Per qualsiasi problema, domanda, idea o suggerimento, potete scrivere ad arm@aliasrevoltmaster.com