diff options
| author | Joe Wilm <joe@jwilm.com> | 2016-10-08 21:30:21 -0700 |
|---|---|---|
| committer | Joe Wilm <joe@jwilm.com> | 2016-10-08 21:30:21 -0700 |
| commit | b80abe9a54acaea65c5ed4e676a9fbc8e211fd40 (patch) | |
| tree | 3f3080db9549194652012001c36ee4721098bed1 /scripts/README.md | |
| parent | b91c90dc34cfb2a1381f3bc3da85a7c223ac480f (diff) | |
| download | alacritty-b80abe9a54acaea65c5ed4e676a9fbc8e211fd40.tar.gz alacritty-b80abe9a54acaea65c5ed4e676a9fbc8e211fd40.zip | |
Add script for creating flamegraph with perf
Resolves #8
Diffstat (limited to 'scripts/README.md')
| -rw-r--r-- | scripts/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
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. |