Documentation

[Ivan-Velickovic]

• Clean up toperf documentation
  • Input format expected by tool should be specified, rather than just including an example.
  • Need to document limitations and what the tool actually
  • version of perf that it's compatible with needs to be mentioned
  • Need isolated example of toperf (for CI testing as well)
  • Need to document like the hacks like mmap and stuff, Dominic's report will be useful.
• Need one example in this repository that makes use of the profiler, in order to show API etc.
• Once the API is finalised, need to document it.
• Need to document what architectures and SoCs it works on.