blob: 4ded546a78a91519dbe9e49b13fd8d4d8d2fa275 [file] [log] [blame]
Jeff Vander Stoepd036b622020-12-17 19:59:02 +01001
2
3A port of the libtest (unstable Rust) benchmark runner to Rust stable releases.
4Supports running benchmarks and filtering based on the name. Benchmark
5execution works exactly the same way and no more (Warning: black_box is not
6working perfectly!).
7
8Please read the `API documentation here`__ (it includes a usage example).
9
10__ https://docs.rs/bencher/
11
12|build_status|_ |crates|_
13
14.. |build_status| image:: https://travis-ci.org/bluss/bencher.svg?branch=master
15.. _build_status: https://travis-ci.org/bluss/bencher
16
17.. |crates| image:: https://meritbadge.herokuapp.com/bencher
18.. _crates: https://crates.io/crates/bencher
19
20Recent Changes
21--------------
22
23- 0.1.5
24
25 - Support trailing commas in the macros by @tbu-
26
27- 0.1.4
28
29 - Add crates.io categories
30
31- 0.1.3
32
33 - Fix doc URL
34 - Fix clippy warnings (by @llogiq)
35
36- 0.1.2
37
38 - Remove unused components (speeds up build time of the crate)
39
40- 0.1.1
41
42 - Add a provisional implementation of ``black_box``. It's not as good as the
43 original version. (Since reproducibility is key, we will use the same
44 implementation on both stable and nightly.)
45 - Add example for how to set up this to run with ``cargo bench`` on stable.
46 This crate is itself an example of that, see ``Cargo.toml`` and ``benches/``
47
48- 0.1.0
49
50 - Initial release
51
52Authors
53-------
54
55Principal original authors of the benchmark and statistics code in the Rust
56project are:
57
58+ Brian Anderson
59+ Graydon Hoare
60
61Very very many have contributed to lib.rs and stats.rs however, so author
62credit is due to:
63
64+ The Rust Project Developers
65
66License
67-------
68
69Dual-licensed just like the Rust project.
70
71Licensed under the Apache License, Version 2.0
72http://www.apache.org/licenses/LICENSE-2.0 or the MIT license
73http://opensource.org/licenses/MIT, at your
74option. This file may not be copied, modified, or distributed
75except according to those terms.