hg/jv-calipel: README.md@fdc2225c104b (annotated)

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
193 48d586497b13 README.md tweaks. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 119 diff changeset	3	Benchmarking made easy
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
196 fdc2225c104b Added two basic principles of CalipeL design to README.md Jan Vrany <jan.vrany@fit.cvut.cz> parents: 193 diff changeset	9	The basic ideas behind are:
fdc2225c104b Added two basic principles of CalipeL design to README.md Jan Vrany <jan.vrany@fit.cvut.cz> parents: 193 diff changeset	10
fdc2225c104b Added two basic principles of CalipeL design to README.md Jan Vrany <jan.vrany@fit.cvut.cz> parents: 193 diff changeset	11	- Benchmarking and (especially) interpreting benchmark results is always
fdc2225c104b Added two basic principles of CalipeL design to README.md Jan Vrany <jan.vrany@fit.cvut.cz> parents: 193 diff changeset	12	a monkey business. Therefore the framework should be as simple as
fdc2225c104b Added two basic principles of CalipeL design to README.md Jan Vrany <jan.vrany@fit.cvut.cz> parents: 193 diff changeset	13	possible so everybody understands the meaning of numbers it gives.
fdc2225c104b Added two basic principles of CalipeL design to README.md Jan Vrany <jan.vrany@fit.cvut.cz> parents: 193 diff changeset	14	- Benchmark results should be kept and managed at single place so one
fdc2225c104b Added two basic principles of CalipeL design to README.md Jan Vrany <jan.vrany@fit.cvut.cz> parents: 193 diff changeset	15	can view and retrieve all past benchmark results pretty much the same
fdc2225c104b Added two basic principles of CalipeL design to README.md Jan Vrany <jan.vrany@fit.cvut.cz> parents: 193 diff changeset	16	way as one can view and retrieve past versions of the software from
fdc2225c104b Added two basic principles of CalipeL design to README.md Jan Vrany <jan.vrany@fit.cvut.cz> parents: 193 diff changeset	17	VCS.
fdc2225c104b Added two basic principles of CalipeL design to README.md Jan Vrany <jan.vrany@fit.cvut.cz> parents: 193 diff changeset	18
fdc2225c104b Added two basic principles of CalipeL design to README.md Jan Vrany <jan.vrany@fit.cvut.cz> parents: 193 diff changeset	19	## Features
100 05426c38a030 Added README.md. Jan Vrany <jan.vrany@fit.cvut.cz> parents: diff changeset	20
119 620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	21	- simple - creating a benchmark is as simple as writing a method in a class
193 48d586497b13 README.md tweaks. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 119 diff changeset	22	- 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
48d586497b13 README.md tweaks. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 119 diff changeset	23	under different conditions
119 620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	24	- 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	25	- 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	26
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	27	## Supported Languages
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	* [Smalltalk/X][4]
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	30	* [Pharo][5]
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	31
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	32	Planned:
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	33
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	34	* Java
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	35	* Ruby
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	36	* Python
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	37
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	38	## More Information
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	39
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	40	...could be found on [wiki][3].
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	41
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	42	## Authors
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	43
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	44	* Jan Vraný `<jan.vrany [*] fit.cvut.cz>`
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	45	* Marcel Hlopko
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	46
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	47	[1]: http://sunit.sourceforge.net/
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	48	[2]: https://code.google.com/p/caliper/
620e7dfcba28 Updated README, added LGPL2 license. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 100 diff changeset	49	[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	50	[4]: http://www.exept.de/de/products/smalltalkx
193 48d586497b13 README.md tweaks. Jan Vrany <jan.vrany@fit.cvut.cz> parents: 119 diff changeset	51	[5]: http://www.pharo-project.org/home

author	Jan Vrany <jan.vrany@fit.cvut.cz>
	Mon, 11 Nov 2013 22:57:04 +0000
changeset 196	fdc2225c104b
parent 193	48d586497b13
child 245	0a69ce2f0505
permissions	-rw-r--r--