Mercurial > repos > public > sbplib_julia

comparison README.md @ 1196:2f208828ae58 tooling/benchmarks

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Just a little bit more readme
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 27 Jan 2023 22:21:08 +0100
parents 8a1de954bdf9
children d4d1eae7c7ca
comparison
equal deleted inserted replaced
1195:8a1de954bdf9 1196:2f208828ae58
44 main(target, baseline) # Compares two revisions 44 main(target, baseline) # Compares two revisions
45 ``` 45 ```
46 46
47 Here `rev`, `target` and `baseline` can be any valid Mercurial revision specifier. 47 Here `rev`, `target` and `baseline` can be any valid Mercurial revision specifier.
48 48
49 PkgBenchmark can also be used directly.
50
49 ```julia 51 ```julia
50 using PkgBenchmark 52 using PkgBenchmark
51 import Sbplib 53 import Sbplib
52 r = benchmarkpkg(Sbplib) 54 r = benchmarkpkg(Sbplib)
53 55
54 export_markdown(stdout, r) 56 export_markdown(stdout, r)
55 ``` 57 ```
56
57 #TODO: Finish this and clean it up
58
59 58
60 ## Generating and using the documentation 59 ## Generating and using the documentation
61 Generating the documentation can be done using either `make` or through activating the `docs` environment and including the script `docs/make.jl` at the REPL. 60 Generating the documentation can be done using either `make` or through activating the `docs` environment and including the script `docs/make.jl` at the REPL.
62 61
63 Using `make` there are three targets 62 Using `make` there are three targets