The Repainters Resource! - The Complete Repaint Walkthrough

The Repainters Resource! - The Complete Repaint Walkthrough - Equipment required

I decided to include this section to complete the process and make it truely a Complete Walkthrough.

So, what is a "readme"?

A readme is a text file giving the downloader information about your file. It's a bit useless uploading something without explaining the installation procedure or any other important information, for example an additional file required for it to work properly. On the other hand, you have to make sure you're to the point and don't waffle on, after all the downloader just wants to get the thing installed! The read me still tends to be created in Notepad as it most likely stems back to the very early Flight Sim days, as pretty much everyone has Notepad there is no problem with a downloader not being able to view it.

Over the years I've seen read mes typed in many different ways, some very basic and some.. not. There is no correct way to make a readme and in most cases it directly relates to what kind of file it is.

What I tend to do is a beginning, middle and end.

The beginning being the introduction to the file, the middle being the installation and the end any additional information.

Below is a readme from one my repaints, the scheme being for Milton Shupe's D18.

********THANK YOU FOR DOWNLOADING MY FILE********

FS2004 - Milton Shupe and Crew's D18 - N431P

Texture files for the D18 by Milton Shupe and friends (d18svc4.zip).

Please enjoy her!

**INSTALLATION INSTRUCTIONS**

The texture files included are the actual livery bmps. To install this paint scheme correctly
please do the following:

1. Place the "texture.N431P" folder inside your aircraft folder, "D18SVC" by default.

2. Go to the folder "texture" and copy all files within this folder.

3. Paste the files into "texture.N431P", when prompted DO NOT overwrite the files.

4. Open the "aircraft.cfg" inside notepad or wordpad.

5. Locate the last similar entry of the following and paste it AFTER this:

ATTENTION: Replace [Fltsim.X] with the next number in numeric order. (Example [fltsim.3])

[fltsim.X]
title=Beech D18S N431P
sim=D18S
model=vc
panel=vc
sound=
texture=N431P
kb_checklists=Beech18_check
kb_reference=Beech18_ref
atc_id=N431P
atc_id_color = 0xffffffff
atc_parking_types = RAMP
atc_parking_code = 1
ui_manufacturer=Beechcraft MSA
ui_type="D18S VC"
ui_variation=N431P
description="B18 VC"
atc_heavy=0
atc_airline=
atc_flight_number=
description=

The above entry is configured to include the virtual cockpit. If you do not wish to include the virtual cockpit
use the following entry:

[fltsim.X]
title=Beech D18S N431P
sim=D18S
model=novc
panel=novc
sound=
texture=N431P
kb_checklists=Beech18_check
kb_reference=Beech18_ref
atc_id=N431P
atc_id_color = 0xffffffff
atc_parking_types = RAMP
atc_parking_code = 1
ui_manufacturer=Beechcraft MSA
ui_type="D18S NOVC"
ui_variation=N431P
description="B18 NOVC"
atc_heavy=0
atc_airline=
atc_flight_number=
description=

6. Exit the "aircraft.cfg" and save changes.

The aircraft should now be fully installed. If you have any difficulties do not hesitate to contact me.

************
MY WALLPAPER WEBSITE
http://members.lycos.co.uk/mcwdainow/

MY REPAINTS WEBSITE
http://members.lycos.co.uk/moggierepaints/

********
With this or any other files of mine I offer full Technical support via email!

If you would like to get in contact with me regarding this file or
any others produced by me, please send your E-mail to: mcwdainow@aol.com
Comments and suggestions are welcome.

Legal information:
This file is copyrighted by Morgan Dainow and should not be altered in
anyway unless given permission to do so.
This file is also freeware and should remain unaltered unless given
authorisation by the author of this file, I give no permission to
allow this file to be payware.

Lets take a closer look at the read me and the different sections to it.

Here we see the beginning of the read me:

********THANK YOU FOR DOWNLOADING MY FILE********

FS2004 - Milton Shupe and Crew's D18 - N431P

Texture files for the D18 by Milton Shupe and friends (d18svc4.zip).

Please enjoy her!

It's important to verify what the file is from the start. If its an aircraft, a repaint, a new panel, then state it. Make sure to include any additional files/packages required for your file to work It's annoying to get half way through the installation only to find out that some extra gauge or scenery package is required. Although people will look through the most known sites (avsim.com, flightsim.com, simviation.com) it's good practice to inform them of where to get the file and whether it is payware or freeware.

We then move on to the main purpose of the read me, the installation.

There are many different ways of explaining the installation process, but the following has generally become the most preferred.. for repaints anyway.

**INSTALLATION INSTRUCTIONS**

The texture files included are the actual livery bmps. To install this paint scheme correctly
please do the following:

1. Place the "texture.N431P" folder inside your aircraft folder, "D18SVC" by default.

2. Go to the folder "texture" and copy all files within this folder.

3. Paste the files into "texture.N431P", when prompted DO NOT overwrite the files.

4. Open the "aircraft.cfg" inside notepad or wordpad.

5. Locate the last similar entry of the following and paste it AFTER this:

ATTENTION: Replace [Fltsim.X] with the next number in numeric order. (Example [fltsim.3])

The above entry is configured to include the virtual cockpit. If you do not wish to include the virtual cockpit
use the following entry:

6. Exit the "aircraft.cfg" and save changes.

The aircraft should now be fully installed. If you have any difficulties do not hesitate to contact me.

The easiest way I find to create the installation procedure is to literally install the download.

Go through step by step and note any extra processes required (for example copying a file from another location to one of the included folders in your package). Theres nothing worse then creating a step by step procedure which doesn't actually make sense, or doesn't work. You can't tell the downloader to place the file in to "folder x" when no such folder exists yet!

Here you can see I've included the procedure to use the non-vc version model with this paint scheme.

Once you have completed the installation section, read through it and install your download again to make sure it all works.

************
MY WALLPAPER WEBSITE
http://members.lycos.co.uk/mcwdainow/

MY REPAINTS WEBSITE
http://members.lycos.co.uk/moggierepaints/

********
With this or any other files of mine I offer full Technical support via email!

If you would like to get in contact with me regarding this file or
any others produced by me, please send your E-mail to: mcwdainow@aol.com
Comments and suggestions are welcome.

In the final section include anything that is not actually related to this particular download. For example, in this case I included links to my websites. I also offer in this case for the downloader to email me for any help or suggestions.I believe for most websites you upload to, this is a mandatory requirement. I then include a small section containing legal information, not knowing how protected we as the creators are.. but at least it's there!

Now save the document as a .txt file and name it something obvious, for example "readme". Don't go overboard ("PLEASE READ ME!!!!") because it probably won't make them read it anymore than they would otherwise and it looks a little desperate!

It's a good idea to create a "master" readme file whereby it is blank and ready for you to fill in. This is so all of your readmes have a continuality between them.. and it's just quicker for you to add the additional bits then make a whole new one..

View the above readme file here.

So there you have it, creating a readme may have been obvious before.. but I hope it is certainly now.

Return to the previous section

Continue to the next section