0
0
mirror of https://github.com/yse/easy_profiler.git synced 2024-12-27 00:21:11 +08:00

Create README.md

This commit is contained in:
Sergey 2016-06-29 06:47:50 +04:00 committed by Sergey Yagovtsev
parent 8b2100a3d6
commit 323d4297ce

26
README.md Normal file
View File

@ -0,0 +1,26 @@
# easy_profiler
Lightweight profiler library for c++
You can profile any function in you code. Furthermore this library provide profiling of any block of code.
Example of usage.
This code snippet will generate block with function name and grouped it in Magenta group:
```cpp
void frame(){
PROFILER_BEGIN_FUNCTION_BLOCK_GROUPED(profiler::colors::Magenta);
prepareRender();
calculatePhysics();
}
```
To profile any block you may do this as following:
```cpp
void frame(){
//some code
PROFILER_BEGIN_BLOCK("Calculating summ");
for(int i = 0; i < 10; i++){
sum += i;
}
PROFILER_END_BLOCK;
}
```