diff -r 71925d2ae258 -r 620e7dfcba28 README.md --- a/README.md Thu Jul 04 11:03:58 2013 +0100 +++ b/README.md Fri Jul 05 03:02:12 2013 +0100 @@ -1,13 +1,40 @@ -## CalipeL +![CalipeL](https://bitbucket.org/janvrany/jv-calipel/raw/71925d2ae258ffe413e495ea680e65a1834b4c13/web/public/images/logo.png) + +*A (simple) tool for performance regression and benchmarking.* -**CalipeL** is a simple benchmarking framework inspired by SUnit and Caliper. +CalipeL is a simple framework to ease development and maintenance +of benchmarks and performance regressions. CalipeL has been heavily +inspired by [SUnit][1] and [Caliper][2] Features: -- simple - the core framework consist of 5 classes. -- flexible - set-up and warm-up can be defined per -benchmark -- multi-language, multi-dialect - the same framework is -implemented in multiple languages to allow for language -comparison. -- web - comes with simple web application to gather and process benchmark results into various graphs. \ No newline at end of file +- *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 +- *multi-language* - supports multiple languages to allow for language/runtime comparison +- *web* - comes with simple web interface to gather and process benchmark results. [Example...](https://swing.fit.cvut.cz/calipel) + +## Supported Languages + +* [Smalltalk/X][4] +* [Pharo][5] + +Planned: + +* Java +* Ruby +* Python + +## More Information + +...could be found on [wiki][3]. + +## Authors + +* Jan Vraný `` +* Marcel Hlopko + +[1]: http://sunit.sourceforge.net/ +[2]: https://code.google.com/p/caliper/ +[3]: https://bitbucket.org/janvrany/jv-calipel/wiki/Home +[4]: http://www.exept.de/de/products/smalltalkx +[5]: http://www.pharo-project.org/home \ No newline at end of file