Attention All Modders: Please include a ReadMe

[Onkel Neal]

Ahoy guys,

The work is great. Could I request/remind you, please include a plain Notepad textfile Readme in your zip/rar files? The name of your mod, your name and credit, a little description of what your mod does, and where it goes/how to add it. There are a lot of new skippers enjoying your work and we want to make it easy for them.



many thanks!
Neal

[ReallyDedPoet]

That's a good idea Some great work out there, lots of new faces to go along with it, this should help.

[Dustyboats]

Originally Posted by Neal Stevens

Ahoy guys,

The work is great. Could I request/remind you, please include a plain Notepad textfile Readme in your zip/rar files? The name of your mod, your name and credit, a little description of what your mod does, and where it goes/how to add it. There are a lot of new skippers enjoying your work and we want to make it easy for them.



many thanks!
Neal

Thank you for this post Neal.....Dusty

[U-Bones]

Might I suggest:

Cool Mod 1.1\Data\modfiles.*
Cool Mod 1.1\Support\Cool Mod 1.1 Readme.txt

I have seen some use this convention and I like it. Readme should be named uniquely to avoid overwriting other mod readmes.

[jimbob]

Also, this works just fine:
Cool Mod 1.1\Data\modfiles.*
Cool Mod 1.1\Documentation\Cool Mod 1.1 Readme.txt

...JSGME ignores the "Documentation" folder
but will copy over "Support" folder.

And if the "Cool Mod 1.1 Readme.txt" is in the same folder than "Data",
JSGME will copy it.

I'd use the Documentation folder, but Support folder is not really that bad either.

[U-Bones]

Originally Posted by jimbob

Also, this works just fine:
Cool Mod 1.1\Data\modfiles.*
Cool Mod 1.1\Documentation\Cool Mod 1.1 Readme.txt

...JSGME ignores the "Documentation" folder
but will copy over "Support" folder.

And if the "Cool Mod 1.1 Readme.txt" is in the same folder than "Data",
JSGME will copy it.

I'd use the Documentation folder, but Support folder is not really that bad either.

Nice ! I did not realize Documentation would be ignored

[Ducimus]

Im going to brag for a moment and say i quite possibly have some of the best documentation included in a mod (its a PITA to keep up too )

[U-Bones]

Originally Posted by Ducimus

Im going to brag for a moment and say i quite possibly have some of the best documentation included in a mod (its a PITA to keep up too )

You do indeed. Kudos

[FIREWALL]

Originally Posted by Ducimus

Im going to brag for a moment and say i quite possibly have some of the best documentation included in a mod (its a PITA to keep up too )

I'll second that and.... Your mods work as advertized.

Originally Posted by Neal Stevens

Ahoy guys,

The work is great. Could I request/remind you, please include a plain Notepad textfile Readme in your zip/rar files? The name of your mod, your name and credit, a little description of what your mod does, and where it goes/how to add it. There are a lot of new skippers enjoying your work and we want to make it easy for them.



many thanks!
Neal

would you please duplicate this sticky post for the SH3 mod workshop.

many noobs need the reminder as they create new mods.