Skip to content

Commit badc79b

Browse files
committed
Update CONTRIBUTING.md for benchmarking instructions.
1 parent cbe46db commit badc79b

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

CONTRIBUTING.md

+15
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,18 @@ license](https://swift.org/LICENSE.txt).
88
Before submitting the pull request, please make sure you have tested your
99
changes and that they follow the Swift project [guidelines for contributing
1010
code](https://swift.org/contributing/#contributing-code).
11+
12+
---
13+
14+
For benchmarking of particular algorithms, please use the
15+
16+
`algorithms-benchmark` executable target. For convenience, this target
17+
18+
already imports `Algorithms`.
19+
20+
Example usage:
21+
22+
`$ swift run -c release algorithms-benchmark run <name-of-results-file> --cycles 5`
23+
24+
`$ swift run -c release algorithms-benchmark render <name-of-results-file> <name-of-chart-file>.png`
25+

0 commit comments

Comments
 (0)