Update bench-runner help
To invlude the package-version and package-name arguments
commit8f28c08bbc0ed331a4ccfdaae727dc65d526091a
authorHarendra Kumar <harendra@composewell.com>
dateThu 9 Mar 2023, 23:12 (4 years ago)
parentf75502c
docs/Developer/Benchmarks.md+8
@@ -51,6 +51,14 @@ $ cabal run bench-runner --project-file=cabal.project.report -- <bench-runner-ar
5151Assuming `bench-runner` is the executable. You can replace `./bench-runner` with
5252`cabal run bench-runner --project-file=cabal.project.report --`
5353
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+
5462Useful commands:
5563
5664```