comparison README.md @ 1195:8a1de954bdf9 tooling/benchmarks

Even more readme
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 27 Jan 2023 22:19:06 +0100
parents 007d90b354af
children 2f208828ae58
comparison
equal deleted inserted replaced
1194:007d90b354af 1195:8a1de954bdf9
37 There are custom functions included for running the benchmarks in this Mercurial repository. To use this first activate the environment in `benchmark/` then include the file `benchmark_utils.jl`. 37 There are custom functions included for running the benchmarks in this Mercurial repository. To use this first activate the environment in `benchmark/` then include the file `benchmark_utils.jl`.
38 38
39 The suite can the be run from the REPL by using the function `main` in one of the following ways 39 The suite can the be run from the REPL by using the function `main` in one of the following ways
40 40
41 ```julia 41 ```julia
42 main() 42 main() # Runs the suite for the current working directory
43 main(rev) 43 main(rev) # Runs the suite at the specified revision
44 main(target, baseline) 44 main(target, baseline) # Compares two revisions
45 ``` 45 ```
46
47 Here `rev`, `target` and `baseline` can be any valid Mercurial revision specifier.
46 48
47 ```julia 49 ```julia
48 using PkgBenchmark 50 using PkgBenchmark
49 import Sbplib 51 import Sbplib
50 r = benchmarkpkg(Sbplib) 52 r = benchmarkpkg(Sbplib)