on master help sign in
Update bench-runner help
8f28c08Harendra Kumar
docs/Developer/Benchmarks.md+8
@@ -51,6 +51,14 @@ $ cabal run bench-runner --project-file=cabal.project.report -- <bench-runner-ar
51Assuming `bench-runner` is the executable. You can replace `./bench-runner` with
51Assuming `bench-runner` is the executable. You can replace `./bench-runner` with
52`cabal run bench-runner --project-file=cabal.project.report --`
52`cabal run bench-runner --project-file=cabal.project.report --`
53
53
54+Note, you need to pass two mandatory arguments to bench-runner,
55+`package-version` and `package-name`. For the streamly-benchmarks package, pass
56+these as below:
57+
58+```
59+bin/bench-runner --package-version 0.0.0 --package-name streamly-benchmarks
60+```
61+
54Useful commands:
62Useful commands:
55
63
56```
64```