Mercurial > repos > public > sbplib_julia

changeset 1194:007d90b354af tooling/benchmarks

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
More readme
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 27 Jan 2023 22:09:13 +0100
parents 04dda6aa9673
children 8a1de954bdf9
files README.md
diffstat 1 files changed, 8 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Fri Jan 27 22:06:12 2023 +0100
+++ b/README.md	Fri Jan 27 22:09:13 2023 +0100
@@ -36,6 +36,14 @@
 
 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`.
 
+The suite can the be run from the REPL by using the function `main` in one of the following ways
+
+```julia
+main()
+main(rev)
+main(target, baseline)
+```
+
 ```julia
 using PkgBenchmark
 import Sbplib