Readme Files - Why they are important

Post Reply
User avatar
LHammonds
Site Admin
Site Admin
Posts: 712
Joined: Fri Jul 31, 2009 6:27 pm
Are you a filthy spam bot?: No
Location: Behind You
Contact:

Readme Files - Why they are important

Post: # 121Post LHammonds
Tue May 25, 2010 8:53 am

Readme files are important no matter what kind of mod/file you share on the Internet. They give a description for the purpose of why you shared the file. It's also very important to include a permissions/licensing/legal section to explain how you'd like this file to be used. You may be surprised at how creative people can be if allowed to use your work and may even think of ways to improve it that you never imagined.

It's also important to include your information as well if you'd like to be given credit for it or to let people know how to contact you. If you had help from other people or resources, be sure to include them in a credits section.

Don't assume that what you type on a forum or web page will "go with" your file. Web sites come and go but the original archives can be re-uploaded to other places and most of the times, the only thing that survives about the original description, information and whatnot are what's included in the archive, specifically the Readme file.

Be sure to include a readme file with whatever you create and share.

I believe that a readme file is so important, that I've created a utility called the Readme Generator.

If I leave the Oblivion scene, I will package the web page application and post it for other to take and share.

Here are some samples of what the Readme Generator can produce:

Readme Sample for SaveGames
Readme Sample for ESP-Only Plugins
Readme Sample for Normal Archives
Readme Sample for OMOD-Ready Archives
Readme Sample for OMOD Archives

Mirror Location: Nexus Wiki

Post Reply