codedownio/time-ghc-modules
1
1
Fork 0
mirror of https://github.com/codedownio/time-ghc-modules.git synced 2024-10-26 07:18:58 +03:00
Code Issues Projects Releases Wiki Activity

Add tips section

Browse Source
This commit is contained in:
Tom McLaughlin 2021-08-03 23:20:36 -07:00
parent d3e9b4e795
commit d506769968
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -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`.