Skip to content

Commit

Permalink
Short description, list of requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
etsvigun committed Feb 14, 2010
1 parent 79a0997 commit 3eb18c9
Showing 1 changed file with 19 additions and 12 deletions.
31 changes: 19 additions & 12 deletions README.markdown
@@ -1,36 +1,43 @@
Chipmunk-FFI
Chipmunk-FFI-Demos
====

Why should I use Chipmunk-FFI
Homepage:: http://github.com/jacius/nice-ffi/
Author:: Evgeniy Tsvigun <jacius@gmail.com>

Description
----------------------

* To use chipmunk's latest features that are not yet present in their bundle or other gems.
* To use chipmunk from within jruby.
* To make shawn42 feel better about spending time on this gem.
A collection of demo applications for Chipmunk physics
engine : http://code.google.com/p/chipmunk-physics/
Mainly, it's a Ruby port of demo apps included in the library's distribution,
using Chipmunk-FFI for binding and Ruby-Processing for visualization.


Install
-------

You will need:

* Ruby 1.8.6+ or JRuby 1.4+
* Ruby 1.8.6+ or JRuby 1.5+ ( yep, use unstable )
* Chipmunk > 5.0 (svn right now... http://code.google.com/p/chipmunk-physics/ )
* FFI > 0.6.0 (git right now... http://github.com/ffi/ffi/ )

Then...
* FFI >= 0.6.0 (git right now... http://github.com/ffi/ffi/ )
* Nice-FFI >= 0.3 ( http://github.com/jacius/nice-ffi/ )
* Chipmunk-FFI > 1.0.0 ( http://github.com/shawn42/chipmunk-ffi/ )

gem install chipmunk-ffi
OK, no gem yet, gonna fix that as soon as there's more stuff to
be packed. And yes, most surely, you'll have to do some fixing
to make it work altogether. If that proves tricky, use lib/ruby-processing-1.0.8.gem,
it contains everything listed above except Chipmunk itself.


License
-------

MIT
Copyright 2009 Shawn Anderson
Copyright 2010 Evgeniy Tsvigun


Author
------

Shawn Anderson <shawn42+chipmunk@gmail.com>
Evgeniy Tsvigun <utgarda@gmail.com>

0 comments on commit 3eb18c9

Please sign in to comment.