Merge pull request #59 from danicheg/tweak-readme

Tweak README

README.md

@@ -30,20 +30,21 @@ Note that in Scala 2.13, the preferred form of the compiler option to enable sta
 
 All the compiler plugin options are **prepended by `-P:scalac-profiling:`**.
 
-* `show-profiles`: Show implicit searches and macro expansions by type and
-  call-site.
-* `sourceroot`: Tell the plugin what is the source directory of the project.
-  Example: `-P:scalac-profiling:sourceroot:$PROJECT_BASE_DIR`.
-* `print-search-result`: Print the result retrieved by an implicit search.
-  Example: `-P:scalac-profiling:print-search-result:$MACRO_ID`.
-* `generate-macro-flamegraph`: Generate a flamegraph for macro expansions. The
-  flamegraph for implicit searches is enabled by default.
-* `print-failed-implicit-macro-candidates`: Print trees of all failed implicit
-  searches that triggered a macro expansion.
+* `generate-global-flamegraph`: Creates a global flamegraph of implicit searches for all compilation units. 
+  Use the `-P:scalac-profiling:sourceroot` option to manage the root directory, 
+  otherwise, a working directory (defined by the `user.dir` property) will be picked.
+* `generate-macro-flamegraph`: Generate a flamegraph for macro expansions. 
+  The flamegraph for implicit searches is enabled by default.
 * `generate-profiledb`: Generate profiledb.
-* `show-concrete-implicit-tparams`: Use more concrete type parameters in the
-  implicit search flamegraph. Note that it may change the shape of the
-  flamegraph.
+* `print-failed-implicit-macro-candidates`: Print trees of all failed implicit searches that 
+  triggered a macro expansion.
+* `print-search-result`: Print the result retrieved by an implicit search. 
+  Example: `-P:scalac-profiling:print-search-result:$MACRO_ID`.
+* `show-concrete-implicit-tparams`: Use more concrete type parameters in the implicit search flamegraph. 
+  Note that it may change the shape of the flamegraph.
+* `show-profiles`: Show implicit searches and macro expansions by type and call-site.
+* `sourceroot`: Tell the plugin what is the source directory of the project. 
+  Example: `-P:scalac-profiling:sourceroot:$PROJECT_BASE_DIR`.
 
 ## Historical context