Documentation Needed

[lukalelovic]

Currently there are functions and classes for the AsciiEngine that are not documented in the README. If a user wants to understand how to use the engine, the main way currently is to actually step through the code and see what functions exist, and what their purpose are.

Documentation in the README on each function in the engine is needed. Each function should have a brief description, explanation of parameters, and unless the function is intuitive to use (such as the quit() function), a piece of example code using the function.

[JaimieVos]

I would like to do this, could I be assigned to this?

[JaimieVos]

In #5 I made some changes to the readme.md. Added some code on the input documentation and removed some unecassary code lines. For what I could see most of it was already well documented.

[lukalelovic]

You are now assigned to this issue, and your changes have been merged, thanks for the work!

[lukalelovic]

New function documentation needed:

• GameObject class
  • moveRelativeTo()
  • readSprite()
• Screen class
  • drawSprite()

Any specification on whether a method is public or private is a nice-to-have feature as well!