Skip to content

Commit

Permalink
Update CONTRIBUTING.md for benchmarking instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
LemonSpike committed Jul 30, 2021
1 parent cbe46db commit badc79b
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,18 @@ license](https://swift.org/LICENSE.txt).
Before submitting the pull request, please make sure you have tested your
changes and that they follow the Swift project [guidelines for contributing
code](https://swift.org/contributing/#contributing-code).

---

For benchmarking of particular algorithms, please use the

`algorithms-benchmark` executable target. For convenience, this target

already imports `Algorithms`.

Example usage:

`$ swift run -c release algorithms-benchmark run <name-of-results-file> --cycles 5`

`$ swift run -c release algorithms-benchmark render <name-of-results-file> <name-of-chart-file>.png`

0 comments on commit badc79b

Please sign in to comment.