Google Code-in

Terasology's Signalling module adds a way to create logic based circuits with a selection of logic gates and triggers. This module was untouched for a while until it was overhauled for GCI so it's in need of touch-ups. A proper readme would help a lot with introducing people to 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)

Definition of 'Done'

• A pull request to the signalling module with a readme that shows off the features of the module.
  • Try and include at least one image in the readme.

Where to start

• Look at some example readme in Teraasology Repos
  • The potions module provides devs with info and lists the potions
  • The cooking module gives information on contributing

See also

• The task to add javadoc to Signalling
• The task to add a test plan to Signalling