From b80abe9a54acaea65c5ed4e676a9fbc8e211fd40 Mon Sep 17 00:00:00 2001 From: Joe Wilm Date: Sat, 8 Oct 2016 21:30:21 -0700 Subject: Add script for creating flamegraph with perf Resolves #8 --- scripts/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 scripts/README.md (limited to 'scripts/README.md') diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 00000000..39897c30 --- /dev/null +++ b/scripts/README.md @@ -0,0 +1,20 @@ +scripts +======= + +There are two scripts included at the time this README was written, and they +both support flamegraph generation on Ubuntu. The first script installs the +required dependencies: + +```sh +scripts/ubuntu-install-perf.sh +``` + +The second script will run Alacritty while recording call stacks. After the +Alacritty process exits, a flamegraph will be generated and its URI printed. + +```sh +scripts/create-flamegraph.sh +``` + +**NOTE**: The _create-flamegraph.sh_ script is intended to be run from the +alacritty project root. -- cgit