md-Files for PHP patterns

[mal-tee]

Atm. the current md files for PHP patterns contain a lot of information, e.g.:

• for every instance:
  • same meta information
    • already present in the .json files
  • the source code
    • already present in the .php files
  • the bytecode
    • already present in the .bash files
    • is that even needed? see PHP: do we need the bytecode dump? #11
  • study results
  • "Preconditions"
  • "Transformations"

Most information in the md file is duplicated from the other files. This is hard to maintain and to understand. How should we proceed to update the md-Files? Are they intended for human readers? Then I'd propose to ditch all information already present in the other files. As far as I understand the md-Files should explain the pattern to an interested user/researchers, so I don't see the necessity to include study results as well.

[compaluca]

• The README.md files were supposed to be created automatically from the framework by using the metadata of the pattern and of the pattern instances.
• Still this requires to have a small description of the pattern and of the instances
• Please use the metadata "description" in the json files of both the pattern and its pattern instances to provide the description