Garmelon/profold
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add proper readme

Browse source
This commit is contained in:
Joscha 2020-03-01 13:28:03 +00:00
parent 74e1c3d31a
commit df96631741
4 changed files with 23 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -1 +1,22 @@
# profold
This project is a terminal-based viewer for ghc `.prof` files. These files are
the result of profiling with `+RTS -p`, and can easily be thousands of lines
long. This makes it cumbersome to browse through them and find the interesting
bits.
Since `.prof` files have a tree-like structure, an obvious improvement for
viewing them is folding and unfolding parts of the tree, which is what profold
allows you to do.
![profold showing a profile of profold](screenshot.png)
## Usage
Open a file with profold:
```
$ profold file_to_open.prof
```
Arrow keys or vim-like keybindings to navigate. Tab to fold or unfold the
current item.