diff -r 94a93aafc8ec -r 5c907ddba18b README.md --- a/README.md Sun Oct 11 06:47:56 2015 +0100 +++ b/README.md Tue Oct 13 19:44:36 2015 +0100 @@ -2,26 +2,26 @@ *Benchmarking made easy* -CalipeL is a simple framework to ease development and maintenance +CalipeL is a simple tool to ease development and maintenance of benchmarks and performance regressions. CalipeL has been heavily inspired by [SUnit][1] and [Caliper][2] -The basic ideas behind are: +The basic ideas that drove the development: - Benchmarking and (especially) interpreting benchmark results is always - a monkey business. Therefore the framework should be as simple as - possible so everybody understands the meaning of numbers it gives. + a monkey business. The tool should produce raw numbers, letting the + user to whichever statisctis she need to make up (desired) results. - Benchmark results should be kept and managed at single place so one can view and retrieve all past benchmark results pretty much the same - way as one can view and retrieve past versions of the software from - VCS. + way as one can view and retrieve past versions of the software from + source code management tool. ## Features - *simple* - creating a benchmark is as simple as writing a method in a class - *flexible* - a special set-up and/or warm-up routines could be specified at benchmark-level as well as set of parameters to allow fine-grained measurements under different conditions -- *multi-language* - supports multiple languages to allow for language/runtime comparison +- *batch runner* - contains a batch runner allowing one to run benchmarks from a command line or at CI servers such as Jenkins. - *web* - comes with simple web interface to gather and process benchmark results. [Example...](https://swing.fit.cvut.cz/calipel) ## Supported Languages / Runtimes @@ -29,7 +29,7 @@ * [Smalltalk/X jv-branch][6] * [Pharo][5] -Planned (if somebody does it) +Planned (would be nice if somebody does it) * Java (on hold) * Ruby