Add info to running builders docs for -md flag which allows user to s…

…pecify output directory for memray
materialsproject · Jun 12, 2023 · 1e5277f · 1e5277f
1 parent cd7b6e0
commit 1e5277f
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/getting_started/running_builders.md b/docs/getting_started/running_builders.md
@@ -138,4 +138,6 @@ The profiler will generate two files after the builder finishes:
 
 ***Note***: Different platforms/operating systems purge their system's `temp` directory at different intervals. It is recommended to move at least the `.bin` file to a more stable location. The `.bin` file can be used to recreate the flamegraph at anytime using the Memray CLI.
 
+Using the flag `--memray-dir` (`-md`) allows for specifying an output directory for the `.bin` and `.html` files created by the profiler. The provided directory will be created if the directory does not exist, mimicking the `mkdir -p` command.
+
 Further data visualization and transform examples can be found in Memray's documentation ([Memray reporters](https://bloomberg.github.io/memray/live.html)).