Contents

= Jeka v0.2.0

Jeka is an awesome build/test/benchmarking tool.

This new version changed a lot! Now, Jeka generates a database containing information about your algorithms and in the future, you will be able to do any kind of analysis you want with the help of plugins.

== Applications

* Repository of algorithms and problems
* Comparison of algorithms and their implementations
* Studies about analysis of algorithms

== Creating a Jeka Repository

See an example here[link:https://github.com/igorbonadio/jeka/tree/master/test/bubble_sort]

== Using

Building a Jeka repository:
  
  $ jeka build "your_repository_folder/**/algorithm_*.rb"

Running implementations:
  
  $ jeka run "your_repository_folder/**/algorithm_*.rb" # it will generate a sqlite3 database named 'analysis.jeka'

== For the future

* Jeka will be used in my next project which is a repository of algorithms and their implementations in several languages. It will be released soon.

== Contributing to jeka
 
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

== Copyright

Copyright (c) 2011 Ígor Bonadio. See LICENSE.txt for
further details.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
jeka-0.2.0	README.rdoc