Mercurial > repos > public > sbplib_julia

changeset 1195:8a1de954bdf9 tooling/benchmarks

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Even more readme
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 27 Jan 2023 22:19:06 +0100
parents 007d90b354af
children 2f208828ae58
files README.md
diffstat 1 files changed, 5 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Fri Jan 27 22:09:13 2023 +0100
+++ b/README.md	Fri Jan 27 22:19:06 2023 +0100
@@ -39,11 +39,13 @@
 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)
+main()                  # Runs the suite for the current working directory
+main(rev)               # Runs the suite at the specified revision
+main(target, baseline)  # Compares two revisions
 ```
 
+Here `rev`, `target` and `baseline` can be any valid Mercurial revision specifier.
+
 ```julia
 using PkgBenchmark
 import Sbplib