README.md
author Jan Vrany <jan.vrany@fit.cvut.cz>
Thu, 01 Aug 2013 23:46:34 +0100
changeset 150 8f61a93024f9
parent 119 620e7dfcba28
child 193 48d586497b13
permissions -rw-r--r--
Allow for multiple values of string parameters.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
119
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
     1
![CalipeL](https://bitbucket.org/janvrany/jv-calipel/raw/71925d2ae258ffe413e495ea680e65a1834b4c13/web/public/images/logo.png)
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
     2
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
     3
*A (simple) tool for performance regression and benchmarking.*
100
05426c38a030 Added README.md.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     4
119
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
     5
CalipeL is a simple framework to ease development and maintenance
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
     6
of benchmarks and performance regressions. CalipeL has been heavily 
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
     7
inspired by [SUnit][1] and [Caliper][2]
100
05426c38a030 Added README.md.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     8
05426c38a030 Added README.md.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     9
Features:
05426c38a030 Added README.md.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    10
119
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    11
- *simple* - creating a benchmark is as simple as writing a method in a class
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    12
- *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 
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    13
- *multi-language* - supports multiple languages to allow for language/runtime comparison
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    14
- *web* - comes with simple web interface to gather and process benchmark results. [Example...](https://swing.fit.cvut.cz/calipel)
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    15
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    16
## Supported Languages
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    17
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    18
* [Smalltalk/X][4]
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    19
* [Pharo][5]
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    20
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    21
Planned:
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    22
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    23
* Java
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    24
* Ruby
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    25
* Python
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    26
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    27
## More Information
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    28
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    29
...could be found on [wiki][3].
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    30
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    31
## Authors
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    32
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    33
* Jan Vraný `<jan.vrany [*] fit.cvut.cz>`
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    34
* Marcel Hlopko
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    35
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    36
[1]: http://sunit.sourceforge.net/
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    37
[2]: https://code.google.com/p/caliper/
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    38
[3]: https://bitbucket.org/janvrany/jv-calipel/wiki/Home
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    39
[4]: http://www.exept.de/de/products/smalltalkx
620e7dfcba28 Updated README, added LGPL2 license.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 100
diff changeset
    40
[5]: http://www.pharo-project.org/home