summaryrefslogtreecommitdiff
path: root/source/profiler/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'source/profiler/readme.md')
-rw-r--r--source/profiler/readme.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/source/profiler/readme.md b/source/profiler/readme.md
new file mode 100644
index 0000000..92b7c2f
--- /dev/null
+++ b/source/profiler/readme.md
@@ -0,0 +1,7 @@
+## Profiler
+
+This is a CMake static library that exposes a C++ API for a very simple logging based profiler implementation. It
+depends on the hardware abstraction layer's platform drivers to get performance measurement counters (PMU) from the
+platform. It makes no assumptions about the type of data these counters might contain and therefore each individual
+platform is free to implement their own flavour. It works on the principle that each counter capsule will have one, or
+several, 64-bit counters which are used to maintain rolling statistics.