Authors: name of authors

Created on: date Updated on: date in case of update

Brief description

Brief demo

Motivation

A motivation is a paragraph that states how your system works and why you choose to do things in a particular way

This should probably be your largest part of the file

Uses

This paragraph explains how to use your code, this isn't documentation but rather a how to get started on understanding and using this code, since that is usually not something that can be explained properly in doxygen

Performance

If your code is performance sensitive, you should do benchmarks and present them here

Unit tests

If your code can be unit tested, it should and you should write a small paragraph about what unit tests are you doing

Expansion

If your code has a clear path for expansion, you should write a small paragraph for future reference

Changelog

If your code got an update because of some reason and added new features, write a short paragraph about what got added and why it was important to add it