diff --git a/CHANGELOG.md b/CHANGELOG.md index 871aa6c..ea29660 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,5 @@ # Changelog for profold ## Upcoming +* add readme * create project diff --git a/README.md b/README.md index 1e8b593..dc46e3f 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/package.yaml b/package.yaml index f11bcaf..6cd09f0 100644 --- a/package.yaml +++ b/package.yaml @@ -4,7 +4,7 @@ license: MIT author: "Garmelon " copyright: "2020 Garmelon" -synopsis: A TUI viewer for GHC .prof files that can fold/unfold sections +synopsis: A TUI viewer for GHC .prof files description: Please see the README on GitHub at github: "Garmelon/profold" diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..ed6da0f Binary files /dev/null and b/screenshot.png differ