The readme should be named after the mission
myMission_readme.txt
A copy of the readme should also be placed inside the mission folder so that it is bundled up inside the .pbo file. It doesn't do any harm there, and can be retrieved if the original readme is lost.
You MUST include:
- Mission Name
- Mission version number
- SP or MP
- Suitable for Cadet mode, Veteran mode or both
- Date
- Author name
- Author email
- OFP version required
- Precise and accurate details of any addons required
- Addon name
- Version of addon
- Author's name
- What it is
- File size
- Correct link to the addon page (the exact page - not the website: not the file)
- Mirrors if they exist in case original link goes down
- Any other special requirements e.g. minimum spec PC
- Installation instructions
- Any known bugs or problems
- Acknowledgements
- Statement that mission is Unofficial
- Disclaimer
- Anything else that the player might need to know. If in doubt, include it
You MAY include:
- Version history details
- Mission Features/Outline
- Details of language support
- Designer's Notes
- Walkthrough
- Beta testers' comments
- Anything else you like
Topic: ReadMe's? (Read 688 times)