Google Code-in

Fix up module readme

The readme provides an introduction to a module. Some of the module readme's haven't been updated in a while. A good readme should provide a strong introduction to someone working or using the module.

A readme is the first thing people see when looking at the module on Github. As such it should provide a quick overview of what the module is. It should list some of the features of the module and point to where more information can be found (If there is any). It's a file named readme.md in the top folder of the repository (next to the module.txt file)

Start off by having a look at the readme's in the Terasology repos as well a the Destination Sol modules and then restructure the content of the readme as in the module readme template

If there are some notes for developers, include them in the readme's "Setup" section as comments, this would hide all the technical details for the player but would be accessible to the developer if needed.

Note: Not all modules will be big or mature enough to where adding a readme makes sense. Look for those where it does!

Acceptance Criteria

• A pull request to the an existing module with a readme that could work with a tweak or an update. This should be at least a few sentences or better yet several sections, but naturally some modules have more to talk about than others
  • Try and include at least one image in the readme.
  • Make sure the file is named README.md

Rejection Criteria

• The supplied readme is trivial to the point of not adding any value to the module

Where to start

• If possibly try to play the game with the content from the specific module to understand it better
• Look at some example readme in Terasology Repos
  • The potions module provides devs with info and lists the potions
  • The cooking module gives information on contributing

Note: This is a multi-instance task - other students can pick it too and might end up fixing the same reports. Take a look at pending PRs in the relevant repo before submitting yours; if another student has already fixed some issues in the same classes as you, you may need to change what you're fixing or wait till the earlier work is merged, then adjust what you're adding.