[req] Please Include A "read Me" With Your Mods

i noticed quite a few mods were packaged to be JSGME ready and you just add them to your mods folder but most of these do not have a "read me" so when you unzip it you just have the mod and nothing to describe what it is or what it does.

i wish to ask all modders to include a "read me" file along side of the actual JSGME ready mod folder so it is easy to see what the mod does instead of having to go to the post where the mod was linked at so you can read about it.

i like to keep all the mods i like on file so at some time i may want all or part of a mods changes for doing my own mod but often (sometimes a month or more later) all i have is a mod with no description and no "read me" to say who made the mod, so i cant give proper credit if i use it and if i need advice or help doing something like it i could use the "read me" to know who to contact.

i wish to ask all modders who have zipped files that dont have a "read me" to please take the time to add one.

i also wish to ask any members who come accross mods with no "read me" to please take the time to send a message to the mod maker asking if he would please add a "read me" to his zipped file. thank you all.

[leovampire]

And I try to make sure they update with the mod update.

But your right it is important that they include one and have it titled the same as the mod not just READ ME.

If the mod is named "Radio Report" then the read me should say:

"Radio Report Read ME"

[JScones]

And don't forget the tip from JSGME's Help file:

- MODDERS: Add a text file to your "documentation" or base folder with the extension ".jsgme" and the contents (up to 255 characters) will be displayed to the user whenever they click on your mod within the Generic Mod Enabler's interface. This is a great way to quickly "remind" users what your mod does.

Also remember that if you add your help file to a folder called "documentation", not only will it not be copied into the game (saving HD space) but users will also be able to read it from within JSGME (by right-clicking your mod).

Just some simple tips to make your mod even more user friendly for JSGME users.

Originally Posted by leovampire

And I try to make sure they update with the mod update.

But your right it is important that they include one and have it titled the same as the mod not just READ ME.

If the mod is named "Radio Report" then the read me should say:

"Radio Report Read ME"

you and everyone else do such good work and try hard to make everything easy on us but in making everything JSGME ready the "read me" is sometimes left out because it confuses people lol. somewhere along the way it became less trouble to just leave out the "read me" so no posts saying mod doesnt work because they didnt understand that the mod folder was within another folder that also had a "read me", i guess for some it was just too confusing lol.

[leovampire]

Originally Posted by JScones

And don't forget the tip from JSGME's Help file:

Also remember that if you add your help file to a folder called "documentation", not only will it not be copied into the game (saving HD space) but users will also be able to read it from within JSGME (by right-clicking your mod).

Just some simple tips to make your mod even more user friendly for JSGME users.

I am getting old I guess! I will work on that tonight and get them set up so people can do that with my stuff in the future thanks for the reminder JScones.

[tater]

Cool, I didn't know or remember that little tidbit regarding the jsgme extension.

I'll have to give that a try.

My readmes need work, too, lol.

tater

[Excalibur Bane]

Hmm. While your at it, do add version numbers. Purely selfish reasons, so I can tell which mods have been updated.

Originally Posted by Excalibur Bane

Hmm. While your at it, do add version numbers. Purely selfish reasons, so I can tell which mods have been updated.

very nice reminder since many small mods dont think to put creation dates or version numbers because it isnt thought to be needed but over time we are sometimes left wondering if it was ever updated or retested for the latest patches.