README.md in benchmark_driver-0.2.4 vs README.md in benchmark_driver-0.3.0
- old
+ new
@@ -1,18 +1,18 @@
-# BenchmarkDriver [](https://travis-ci.org/k0kubun/benchmark_driver)
+# Benchmark::Driver [](https://travis-ci.org/k0kubun/benchmark_driver)
Benchmark driver for different Ruby executables
## Installation
$ gem install benchmark_driver
## Usage
```
-$ exe/benchmark_driver -h
-Usage: benchmark_driver [options] [YAML]
+$ benchmark-driver -h
+Usage: benchmark-driver [options] [YAML]
-e, --executables [EXECS] Ruby executables (e1::path1; e2::path2; e3::path3;...)
-i, --ips [SECONDS] Measure IPS in duration seconds (default: 1)
-l, --loop-count [COUNT] Measure execution time with loop count (default: 100000)
-v, --verbose
```
@@ -29,11 +29,11 @@
```
you can benchmark the script with multiple ruby executables.
```
-$ exe/benchmark_driver benchmarks/example_single.yml -e ruby1::ruby -e ruby2::ruby
+$ benchmark-driver benchmarks/example_single.yml -e ruby1::ruby -e ruby2::ruby
benchmark results:
Execution time (sec)
name ruby1 ruby2
example_single 0.958 0.972
@@ -43,11 +43,11 @@
```
And you can change benchmark output to IPS (iteration per second) by `-i` option.
```
-$ exe/benchmark_driver benchmarks/example_single.yml -e ruby1::ruby -e ruby2::ruby -i
+$ benchmark-driver benchmarks/example_single.yml -e ruby1::ruby -e ruby2::ruby -i
Result -------------------------------------------
ruby1 ruby2
example_single 99414.1 i/s 99723.3 i/s
Comparison: example_single
@@ -74,11 +74,11 @@
```
you can benchmark the scripts with multiple ruby executables.
```
-$ exe/benchmark_driver benchmarks/example_multi.yml -e ruby1::ruby -e ruby2::ruby
+$ benchmark-driver benchmarks/example_multi.yml -e ruby1::ruby -e ruby2::ruby
benchmark results:
Execution time (sec)
name ruby1 ruby2
join 0.022 0.022
interpolation 0.026 0.026
@@ -88,11 +88,11 @@
join 1.045
interpolation 1.002
```
```
-$ exe/benchmark_driver benchmarks/example_multi.yml -e ruby1::ruby -e ruby2::ruby -i
+$ benchmark-driver benchmarks/example_multi.yml -e ruby1::ruby -e ruby2::ruby -i
Result -------------------------------------------
ruby1 ruby2
join 4701954.3 i/s 4639520.3 i/s
interpolation 4263170.0 i/s 4044083.0 i/s
@@ -140,10 +140,10 @@
### Debugging
If you have a trouble like an unexpectedly fast result, you should check benchmark script by `-v`.
```
-$ exe/benchmark_driver benchmarks/example_multi.yml -v
+$ benchmark-driver benchmarks/example_multi.yml -v
--- Running "join" with "ruby" 957780 times ---
a = 'a' * 100
b = 'b' * 100