User:FooBar/Generic NewGRF Readme - Revision history

Supercheese: Fixing numbering issues; hope you don't mind!

2012-01-22T22:17:14Z

Fixing numbering issues; hope you don't mind!

← Older revision		Revision as of 22:17, 22 January 2012
Line 21:		Line 21:
	1 About		1 About
	2 General information		2 General information
	1.1 Requirements		2.1 Requirements
	1.2 Installation		2.2 Installation
	1.3 Parameter settings		2.3 Parameter settings
	1.4 Usage		2.4 Usage
		⚫	3 Known issues
	3 Background information		4 Background information
⚫	4 Known issues
	5 Frequently Asked Questions		5 Frequently Asked Questions
	6 Credits		6 Credits
Line 55:		Line 55:
	---------------------		---------------------

	1.1 Requirements		2.1 Requirements
	----------------		----------------
	- OpenTTD <1.2.0> or nightly r<22723>		- OpenTTD <1.2.0> or nightly r<22723>
Line 61:		Line 61:


	1.2 Installation		2.2 Installation
	----------------		----------------
	OpenTTD:		OpenTTD:
Line 71:		Line 71:


	1.3 Parameter settings		2.3 Parameter settings
	----------------------		----------------------
	<some notes on what settings are available>		<some notes on what settings are available>
Line 91:		Line 91:


	1.4 Usage		2.4 Usage
	---------		---------
	<some notes on how to use this NewGRF>		<some notes on how to use this NewGRF>
Line 98:		Line 98:

	--------------		--------------
	4 Known issues		3 Known issues
	--------------		--------------

FooBar: update introduction

2012-01-22T13:06:52Z

update introduction

← Older revision		Revision as of 13:06, 22 January 2012
Line 1:		Line 1:
	This is an attempt at a generic layout for NewGRF readmes. ~~Optimized~~ ~~for~~ ~~use~~ with ~~the~~ ~~ingame~~ ~~viewer~~ of ~~OpenTTD~~ ~~(i.e.~~ ~~gameplay~~ ~~related~~ ~~stuff~~ ~~first).~~ ~~Also~~ ~~a checklist~~ to ~~see~~ if ~~all~~ ~~things~~ ~~are~~ ~~covered.~~		This is an attempt at a generic layout for NewGRF readmes. It provides you with a layout to use, has several sections pre-filled and suggestions on what to put in the other. It is aimed to serve as:
			* a template that you can modify for your own NewGRF;
			* an optimized order of sections for used with the OpenTTD readme viewer (i.e. gameplay related stuff first);
			* a checklist to see if you have all important bits covered in your readme;
			* inspiration in case you want to write your own readme.

	Feel free to use this for ~~your~~ ~~own~~ NewGRF, ~~provided~~ ~~it's~~ released under the GNU General Public Licence 2.0 or higher (~~this~~ example is licensed ~~GPLv2~~+).		Feel free to use this as basis for the readme of your NewGRF. The only thing I ask is that your NewGRF is released under the GNU General Public Licence 2.0 or 3.0 or higher (your choice which one/combination exactly). This example itself is licensed GNU GPL v2+.

			What you have to do yourself is of course fill in the missing pieces. Don't forget to set the correct game version requirements and update the urls in the contact information section. Many predefined bits are aimed at hosting your NewGRF at the [http://dev.openttdcoop.org/ #openttdcoop DevZone], but you can just modify that if you're not hosting your grf there.

	==Readme.txt==		==Readme.txt==
Line 51:		Line 57:
	1.1 Requirements		1.1 Requirements
	----------------		----------------
	- OpenTTD 1.2.0 or nightly ~~r22723~~		- OpenTTD <1.2.0> or nightly r<22723>
	- TTDPatch nightly ~~r2200~~		- TTDPatch nightly r<2200>


Line 146:		Line 152:
	Please report any bugs you find at		Please report any bugs you find at
	bug tracker: http://dev.openttdcoop.org/projects/<projectname>/issues		bug tracker: http://dev.openttdcoop.org/projects/<projectname>/issues
	or forum topic: http://www.tt-forums.net/viewtopic.php?t=00000		or forum topic: http://www.tt-forums.net/viewtopic.php?t=<00000>

	Always included a detailed description of the bug, preferrably with		Always included a detailed description of the bug, preferrably with
Line 165:		Line 171:
	If you have any problems using this NewGRF that are not covered in the		If you have any problems using this NewGRF that are not covered in the
	Frequently Asked Questions above, then you can ask your questions in the		Frequently Asked Questions above, then you can ask your questions in the
	forum topic: http://www.tt-forums.net/viewtopic.php?t=00000		forum topic: http://www.tt-forums.net/viewtopic.php?t=<00000>

FooBar: added known issues and one line description

2012-01-22T12:56:02Z

added known issues and one line description

← Older revision		Revision as of 12:56, 22 January 2012
Line 7:		Line 7:
	{{GRF_TITLE}}		{{GRF_TITLE}}
	===================================		===================================
			<one-line description of what the grf does>

			----------
		⚫	0 Contents
			----------

⚫	Contents:
	1 About		1 About
	2 General information		2 General information
Line 16:		Line 20:
	1.4 Usage		1.4 Usage
	3 Background information		3 Background information
			4 Known issues
	4 Frequently Asked Questions		5 Frequently Asked Questions
	5 Credits		6 Credits
	6 Contact information		7 Contact information
	6.1 Bug reports
	6.2 ~~Other~~ ~~problems~~		7.1 Bug reports
	6.3 ~~General~~ ~~enquiries~~		7.2 Other problems
			7.3 General enquiries
	7 License		8 License
	8 Obtaining the source		9 Obtaining the source


Line 31:		Line 36:
	-------		-------

	<in a ~~few~~ ~~lines~~ what this grf is about, what it contains and what it does>		<one or two paragraphs what this grf is about, what it contains and what it does>

	{{GRF_TITLE}}		{{GRF_TITLE}}
Line 84:		Line 89:
	<some notes on how to use this NewGRF>		<some notes on how to use this NewGRF>



			--------------
			4 Known issues
			--------------

			<list of known issues in this release>


	------------------------		------------------------
	3 Background information		4 Background information
	------------------------		------------------------

Line 96:		Line 108:

	----------------------------		----------------------------
	4 Frequently Asked Questions		5 Frequently Asked Questions
	----------------------------		----------------------------

Line 105:		Line 117:

	---------		---------
	5 Credits		6 Credits
	---------		---------

Line 127:		Line 139:

	---------------------		---------------------
	6 Contact information		7 Contact information
	---------------------		---------------------

	6.1 Bug reports		7.1 Bug reports
	---------------		---------------
	Please report any bugs you find at		Please report any bugs you find at
Line 149:		Line 161:


	6.2 Other problems		7.2 Other problems
	------------------		------------------
	If you have any problems using this NewGRF that are not covered in the		If you have any problems using this NewGRF that are not covered in the
Line 156:		Line 168:


	6.3 General enquiries		7.3 General enquiries
	---------------------		---------------------

Line 166:		Line 178:

	---------		---------
	7 License		8 License
	---------		---------

Line 189:		Line 201:

	----------------------		----------------------
	8 Obtaining the source		9 Obtaining the source
	----------------------		----------------------

FooBar: save

2012-01-16T17:59:30Z

save

New page

This is an attempt at a generic layout for NewGRF readmes. Optimized for use with the ingame viewer of OpenTTD (i.e. gameplay related stuff first). Also a checklist to see if all things are covered.

Feel free to use this for your own NewGRF, provided it's released under the GNU General Public Licence 2.0 or higher (this example is licensed GPLv2+).

==Readme.txt==
<pre>
{{GRF_TITLE}}
===================================

Contents:
1 About
2 General information
1.1 Requirements
1.2 Installation
1.3 Parameter settings
1.4 Usage
3 Background information
4 Frequently Asked Questions
5 Credits
6 Contact information
6.1 Bug reports
6.2 Other problems
6.3 General enquiries
7 License
8 Obtaining the source

-------
1 About
-------

<in a few lines what this grf is about, what it contains and what it does>

{{GRF_TITLE}}
MD5Hash: {{GRF_MD5}}
Version: {{REPO_REVISION}}
GRF ID: {{GRF_ID}}

---------------------
2 General information
---------------------

1.1 Requirements
----------------
- OpenTTD 1.2.0 or nightly r22723
- TTDPatch nightly r2200

1.2 Installation
----------------
OpenTTD:
see http://wiki.openttd.org/NewGRF
This NewGRF is available from the ingame Online Content

TTDPatch:
see http://www.tt-wiki.net/wiki/NewGraphicsInstallation

1.3 Parameter settings
----------------------
<some notes on what settings are available>

Set the parameters before starting a new game. Once started they
cannot be changed any longer.

Useful details if you need to set the parameters manually in the
configuration file:

1st parameter: <description>
0: <what this value does>
1: <what this value does>
2: <what this value does>

2nd parameter: <description>
0: <what this value does>
1: <what this value does>

1.4 Usage
---------
<some notes on how to use this NewGRF>

------------------------
3 Background information
------------------------

<in this section you can give some background information on the
contents of this NewGRF>

----------------------------
4 Frequently Asked Questions
----------------------------

Q: Why is it that...?
A: No reason.

---------
5 Credits
---------

Graphics:
- <artist 1>
- <artist 2>
- <artist 3>

Code:
- <coder 1>
- <coder 2>

Translations:
- <translator 1>
- <translator 2>

Makefile system:
- <usually planetmaker>

---------------------
6 Contact information
---------------------

6.1 Bug reports
---------------
Please report any bugs you find at
bug tracker: http://dev.openttdcoop.org/projects/<projectname>/issues
or forum topic: http://www.tt-forums.net/viewtopic.php?t=00000

Always included a detailed description of the bug, preferrably with
screenshot and savegame. Also state the exact game version you're using,
as well as the version of this NewGRF.

If you have a savegame that includes NewGRFs not available on OpenTTD's
Online Content, then please try to reproduce the bug in a new game
which has all NewGRFs easily accessible.

If you're using a patched version of the game, please try to reproduce
the bug on an official game build. If you can't reproduce the bug, then
don't report it here but in the forum topic of the patch(pack) instead.

6.2 Other problems
------------------
If you have any problems using this NewGRF that are not covered in the
Frequently Asked Questions above, then you can ask your questions in the
forum topic: http://www.tt-forums.net/viewtopic.php?t=00000

6.3 General enquiries
---------------------

If you have any queries that cannot be asked in the forum topic, then
contact <username> via Private Message at www.tt-forums.net or send
an email to <name> at <email address>.

---------
7 License
---------

<name of the NewGRF> - <short description>
Copyright (C) <year> <list of authors or team name>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

----------------------
8 Obtaining the source
----------------------

The source code can be obtained from the #openttdcoop DevZone
via source browser:
http://dev.openttdcoop.org/projects/<projectname>/repository
or via mercurial checkout:
hg clone http://hg.openttdcoop.org/<projectname>
or via a source bundle download (releases only):
http://bundles.openttdcoop.org/<projectname>/

How to build from source and the requirements for that are included
with the source in the file /docs/building_from_source.txt.
</pre>