best practices

This project was originally forked from an open-source project however during the time it was part of a dissertation the development was done on a private repository.

This means many areas such as CI and public documentation are missing (or are formatted in such a way that they can be submitted for marking). These areas should be addressed to allow people to actually use the library or contribute to development.