diff options
| author | Nathan Lilienthal <nathan@nixpulvis.com> | 2018-12-08 15:28:57 -0500 |
|---|---|---|
| committer | Christian Duerr <chrisduerr@users.noreply.github.com> | 2018-12-08 20:28:57 +0000 |
| commit | f32facfbfd3d46b76744d118fd2fa5123501f900 (patch) | |
| tree | a2b8835a62f80faf24d6bd120c6622a317b26b56 /scripts/README.md | |
| parent | 6b61e967390b2fa4a24f962c4771cdd82e0e9de3 (diff) | |
Refactor Alacritty scripts
This includes some changes to the scripts `README.md` to provide
some more information on the different Alacritty scripts.
A new script for testing the 24 bit support of Alacritty has been
added with the `24-bit-color.sh` name. This should help with
troubleshooting truecolor support issues.
Since `perf` is a standard tool which is available in the official
repositories for most distributions, it doesn't make much sense to
provide an installation script specifically for Ubuntu. As a result of
this, the script has been removed.
Diffstat (limited to 'scripts/README.md')
| -rw-r--r-- | scripts/README.md | 28 |
1 files changed, 17 insertions, 11 deletions
diff --git a/scripts/README.md b/scripts/README.md index 39897c30..a560b3b6 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -1,20 +1,26 @@ -scripts +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: +## Flamegraph + +Run the release version of Alacritty while recording call stacks. After the +Alacritty process exits, a flamegraph will be generated and it's URI printed +as the only output to STDOUT. ```sh -scripts/ubuntu-install-perf.sh +./create-flamegraph.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. +Running this script depends on an installation of `perf`. + +## ANSI Color Tests + +We include a few scripts for testing the color of text inside a terminal. The +first shows various foreground and background varients. The second enumerates +all the colors of a standard terminal. The third enumerates the 24-bit colors. ```sh -scripts/create-flamegraph.sh +./fg-bg.sh +./colors.sh +./24-bit-colors.sh ``` - -**NOTE**: The _create-flamegraph.sh_ script is intended to be run from the -alacritty project root. |