Skip to content

Commit

Permalink
Add tips section
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasjm committed Aug 4, 2021
1 parent d3e9b4e commit d506769
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,20 @@ stack build --ghc-options "-ddump-to-file -ddump-timings"

![hledger profile](./hledger.png)

# Tips

The script will output its log messages to `stderr` and print the final report path to `stdout` (assuming it didn't exit with a failure). This makes it easy to use the output in scripts. For example:

``` shell
# Build the report and open it in your browser
> firefox $(/path/to/time-ghc-modules/time-ghc-modules)
```

``` shell
# Build the report in CI and stash it somewhere
> cp $(/path/to/time-ghc-modules/time-ghc-modules) $MY_CI_ARTIFACTS_DIR/
```

# Compatibility

The flag `-ddump-timings` is available for `GHC >= 8.4.1`.

0 comments on commit d506769

Please sign in to comment.