Difference between revisions of "Readme files - Why they are important"

From Nexus Mods Wiki
Jump to: navigation, search
m (Added some FO3 links)
(New domain name for the web site)
Line 8: Line 8:
 
Be sure to include a readme file with whatever you create and share.
 
Be sure to include a readme file with whatever you create and share.
  
LHammonds believed that a readme file is so important, that he created a utility called the [http://lhammonds.game-host.org/obmm/tools_readme_generator1.asp Oblivion Readme Generator].
+
LHammonds believed that a readme file is so important, that he created a utility called the [http://HammondsLegacy.com/obmm/tools_readme_generator1.asp Oblivion Readme Generator].
  
 
==Samples==
 
==Samples==
 
Here are some samples of what the Oblivion Readme Generator can produce:
 
Here are some samples of what the Oblivion Readme Generator can produce:
  
* [http://lhammonds.game-host.org/obmm/readme_savegame.txt Readme Sample for Oblivion SaveGames]
+
* [http://HammondsLegacy.com/obmm/readme_savegame.txt Readme Sample for Oblivion SaveGames]
* [http://lhammonds.game-host.org/obmm/readme_gen_esp.txt Readme Sample for Oblivion ESP-Only Plugins]
+
* [http://HammondsLegacy.com/obmm/readme_gen_esp.txt Readme Sample for Oblivion ESP-Only Plugins]
* [http://lhammonds.game-host.org/obmm/readme_gen_normal.txt Readme Sample for Oblivion Normal Archives]
+
* [http://HammondsLegacy.com/obmm/readme_gen_normal.txt Readme Sample for Oblivion Normal Archives]
* [http://lhammonds.game-host.org/obmm/readme_gen_omodready.txt Readme Sample for Oblivion OMOD-Ready Archives]
+
* [http://HammondsLegacy.com/obmm/readme_gen_omodready.txt Readme Sample for Oblivion OMOD-Ready Archives]
* [http://lhammonds.game-host.org/obmm/readme_gen_omod.txt Readme Sample for Oblivion OMOD Archives]
+
* [http://HammondsLegacy.com/obmm/readme_gen_omod.txt Readme Sample for Oblivion OMOD Archives]
  
 
The same format can also be modified for use with other games:
 
The same format can also be modified for use with other games:
Line 23: Line 23:
 
* Readme Sample for Fallout 3 SaveGames
 
* Readme Sample for Fallout 3 SaveGames
 
* Readme Sample for Fallout 3 ESP-Only Plugins
 
* Readme Sample for Fallout 3 ESP-Only Plugins
* [http://lhammonds.game-host.org/obmm/readme_gen_fo3_normal.txt Readme Sample for Fallout 3 Normal Archives]
+
* [http://HammondsLegacy.com/obmm/readme_gen_fo3_normal.txt Readme Sample for Fallout 3 Normal Archives]
* [http://lhammonds.game-host.org/obmm/readme_gen_fo3_fommready.txt Readme Sample for Fallout 3 FOMM-Ready Archives]
+
* [http://HammondsLegacy.com/obmm/readme_gen_fo3_fommready.txt Readme Sample for Fallout 3 FOMM-Ready Archives]
 
* Readme Sample for Fallout 3 FOMM Archives
 
* Readme Sample for Fallout 3 FOMM Archives
  
 
==References==
 
==References==
[http://lhammonds.game-host.org/forum/viewtopic.php?f=40&t=92 LHammonds Oblivion Mods Site]
+
[http://HammondsLegacy.com/forum/viewtopic.php?f=40&t=92 LHammonds Oblivion Mods Site]
  
 
[[Category:Tutorials]]
 
[[Category:Tutorials]]

Revision as of 08:49, 9 May 2011

Overview

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 is also very important to include a permissions/licensing/legal section to explain how you would 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 is also important to include your information as well if you would 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.

Do not 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 is included in the archive, specifically the Readme file.

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

LHammonds believed that a readme file is so important, that he created a utility called the Oblivion Readme Generator.

Samples

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

The same format can also be modified for use with other games:

References

LHammonds Oblivion Mods Site