The other day, I downloaded a mod for UT2004. It was a .ut3mod file, so there was no way for me to know that it had readme.txt in it. The readme.txt in the mod replaced the UT2004 file, and after I read it I found it was about 4 lines long, saying nothing but “Thanks for downloading this mod!” Again and again.
I have experienced this countless times in many games, and it’s time to put a stop to this idiocy.
So, I decided to write this little article.
There are 3 main things to consider in a readme file.
This is one of the biggest problems. Many times I’ve taken the time to read a readme, and it’s nothing but an advertisement for some site and some other useless information.
Keep everything in your readme file related to what it’s a readme for! If I’m reading a readme for a video game, I don’t expect to find info about how to use my washing machine. Keep it related!
This is the biggest problem with readme files I’ve ever seen.
Think of this: every game out there has a readme file. Over 90% of those readme files are “readme.txt,” “readme.doc,” or “readme” with some other file extension.
Then think of this: Over 90% of user files use files with the name “readme”. This will overwrite the official files, but it’s also important to remember that if you simply use “readme,” it’s quite likely that your readme will be overwritten the next time the user downloads a file. Use a filename that’s original!
3.) Filename again.
Yes, it’s that important.
I hope you uneducated fools will learn something from this.
BYE, AND GOD BLESS YOU.
Eat your lima beans, Johnny.