Readme.txt Template
Posted: Mon Oct 16, 2006 10:07 am
I've uploaded a Readme.txt template for those of you who create addons for EHM. The template is set out so that it provides details of what the addon is/does and how to install it. It also points them to the TBL Forums in case they're having problems installing.
A readme.txt file is pretty important to include because it helps those who don't know where to put the files they've just downloaded. I thought I'd upload the template I use (based on Minstrel's readme files) just to help everyone else.
Here's the link to download the template.
Here's some information on filling in the details of the template:
<<NAME OF ADDON>> - The name/title of your addon
<<Username>> - The author of the file (your name or TBL username)
<<Description of addon>> - A description of your addon. What does it do?
<<How to install>> - How to install the files. This usually involves extracting files from a ZIP file to a certain place. There are two main ways that files can be extracted. Below are two templates you could use to explain how to extract the files in each situation:
1) Using the directory structure stored in the ZIP file
Extract the ZIP file to "NHL Eastside Hockey Manager 2007\data\pictures\logos\clubs\small\" (ensure that you enable the option to use the directory structure of the ZIP file when extracting. In Winzip this option is called "Use folder names").
This will place the files in a folder called "Ontario Hockey League" in "NHL Eastside Hockey Manager 2007\data\pictures\logos\clubs\small".
2) Extracting the files straight into the folder where they belong
Extract the files in the ZIP file to "NHL Eastside Hockey Manager 2007\data\pictures\backgrounds\clubs\Great Britain\" (you may need to create some of these folders if they do not exist).
I know this is all very basic and straightforward, but having a template really does save a lot of time when you're making your addons. It also ensures that you explain what the addon does and how to install it correctly.
Normally, the file is called readme.txt but I name it _readme.txt because then the file comes first in the file list. This ensures that people see that there is a readme file, rather than having to scroll down to search for it.
A readme.txt file is pretty important to include because it helps those who don't know where to put the files they've just downloaded. I thought I'd upload the template I use (based on Minstrel's readme files) just to help everyone else.
Here's the link to download the template.
Here's some information on filling in the details of the template:
<<NAME OF ADDON>> - The name/title of your addon
<<Username>> - The author of the file (your name or TBL username)
<<Description of addon>> - A description of your addon. What does it do?
<<How to install>> - How to install the files. This usually involves extracting files from a ZIP file to a certain place. There are two main ways that files can be extracted. Below are two templates you could use to explain how to extract the files in each situation:
1) Using the directory structure stored in the ZIP file
Extract the ZIP file to "NHL Eastside Hockey Manager 2007\data\pictures\logos\clubs\small\" (ensure that you enable the option to use the directory structure of the ZIP file when extracting. In Winzip this option is called "Use folder names").
This will place the files in a folder called "Ontario Hockey League" in "NHL Eastside Hockey Manager 2007\data\pictures\logos\clubs\small".
2) Extracting the files straight into the folder where they belong
Extract the files in the ZIP file to "NHL Eastside Hockey Manager 2007\data\pictures\backgrounds\clubs\Great Britain\" (you may need to create some of these folders if they do not exist).
I know this is all very basic and straightforward, but having a template really does save a lot of time when you're making your addons. It also ensures that you explain what the addon does and how to install it correctly.
Normally, the file is called readme.txt but I name it _readme.txt because then the file comes first in the file list. This ensures that people see that there is a readme file, rather than having to scroll down to search for it.
