Rename README.md to rootbench-scripts/README.md

rootbench-scripts/README.md

@@ -0,0 +1,32 @@
+## About
+
+flamegraph.sh is a script that generates Flame Graphs for each benchmark in `rootbench.git`. More information on Flame Graphs can be found [here](http://www.brendangregg.com/flamegraphs.html).
+
+## Options
+
+See the USAGE message (--help) for options.
+
+In order to generate flamegraphs for all the benchmarks at once you need to run the following command
+```bash
+flamegraph.sh -d path/to/rootbench/build/dir -a
+```
+To generate FlameGraphs for specific bechmark just run
+ ```bash
+flamegraph.sh -d path/to/rootbench/build/dir -b path/to/benchmark
+```
+## Configuration
+
+If `perf` cannot find symbols in the program try to execute the following commands
+```bash
+echo 0 > /proc/sys/kernel/kptr_restrict
+echo 1 > /proc/sys/kernel/sched_schedstats
+```
+
+To generate flamegraphs for each benchmark add `-Dflamegraph=ON` option to your cmake configuration when building rootbench.
+
+```bash
+cmake ../rootbench -Dflamegraph=ON
+make -j4
+ctest -V -R rootbench-CLASSNAMEBenchmarks
+```
+You can also run the script for Flame Graph generation from your rootbench directory.