Addon Readme Template
Addon Readme Template
The following text can be freely used as a basis for creating a readme text to accompany community made addon distribution. Note text inside square brackets is intended as example or placeholder text and should be replaced.
=====================================
[Addon name]
Version:
Release date:
Author(s): [Addon Team Name. For full details refer to Credits below]
Multiplayer compatible: [Yes/No]
=====================================
An unofficial addon for the PC game "Arma 2: Operation Arrowhead" by Bohemia Interactive.
=====================================
DESCRIPTION
=====================================
[Addon descriptive text]
=====================================
REQUIREMENTS
=====================================
Arma 2 - version [1.XX] - Bohemia Interactive
Arma 2: Operation Arrowhead - version [1.XX] - Bohemia Interactive
British Armed Forces - version [1.XX] - Bohemia Interactive
Private Military Contractors - version [1.XX] - Bohemia Interactive
[Addon Name] - [Version] - [Author]
[Addon Name] - [Version] - [Author]
=====================================
INSTALLATION
=====================================
Use of a mod folder is recommended (MODFOLDER in the following examples).
Extract the supplied files into a folder such as "Arma2/MODFOLDER/Addons".
Start the game using the -mod=MODFOLDER parameter.
For more information, please refer to http://community.bistudio.com/wiki/Modfolders
=====================================
TECHNICAL DETAILS
=====================================
[Class names, script syntax, etc]
=====================================
KNOWN ISSUES
=====================================
[Known issue description]
=====================================
VERSION HISTORY
=====================================
[1.0 - Initial release]
=====================================
LICENSE
=====================================
[Example License text follows:
Copyright (c) 2012 by Addon Team Name authors. This work is licensed under the Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License.
To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-nd/3.0/ or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.]
=====================================
CREDITS
=====================================
[Example credit text follows:
Addon Team Name authors are Joe Bloggs, Fred Bloggs and Joe Blow.
This addon makes use of textures © 2010 John Smith, used under a Creative Commons Attribution-Noncommercial license: http://creativecommons.org/licenses/by-nc/3.0/.]
=====================================
CONTACT DETAILS
=====================================
[Example credit text follows:
Addon Team Name can be contacted at addon.team@email.net]