[game-data-packager] 01/01: adding_a_game: document YAML 'description:' tag

[Alexandre Detiste]

This is an automated email from the git hooks/post-receive script.

detiste-guest pushed a commit to branch master
in repository game-data-packager.

commit 93626c9c701ae2eb41127419aec8f5d99e142103
Author: Alexandre Detiste <alexandre.detiste at gmail.com>
Date:   Thu Oct 8 13:47:50 2015 +0200

    adding_a_game: document YAML 'description:' tag
---
 doc/adding_a_game.mdwn | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/doc/adding_a_game.mdwn b/doc/adding_a_game.mdwn
index ba7cf6a..6a35ff3 100644
--- a/doc/adding_a_game.mdwn
+++ b/doc/adding_a_game.mdwn
@@ -127,18 +127,15 @@ section of a binary package
  * the control file
  * a copyright file, in `/usr/share/doc/package/copyright`
 
-For new games in `game-data-packager` these are normally
-`data/*.control.in` and `data/*.copyright`.
-
 `game-data-packager` will automatically build the copyright file
 using the contents of the `copyright:` tags in the yaml file;
 you only need to provide one if the default generated
 copyright file isn't suitable; see for example
 `data/descent1-demo-data.copyright`.
 
-`game-data-packager` will automatically provide the control file
-with default values if missing. It will also ensure that
-all the field required by policy are present:
+`game-data-packager` will automatically build the control file.
+It will also ensure that all the field required by policy
+are present:
 
  * `Version` field. This will automatically be filled with
    the version of gdp which generated the template package.
@@ -150,6 +147,8 @@ all the field required by policy are present:
    will be provided if this field is missing.
  * `Description`. Both the single line synopsis and the extended
    description that follows.
+   Most of the extended description is automatically edited,
+   you can provide extra information by using a `description:` tag.
  * Any required dependencies.  For game data packages, we use
    `Recommends` to recommend a corresponding engine package, where
    appropriate. To document an engine, you should add

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-games/game-data-packager.git