= important

This project has been superceded by {Jax}[http://github.com/sinisterchipmunk/jax], a featureful, Ruby-powered, Rails-like framework designed to rapidly spit out beautiful WebGL applications. Jax is designed to work with Rails out-of-the-box, but of course Rails is not a requirement to use Jax.

If you're interested in developing WebGL-enabled applications, either with or without Rails, you should hop on over to http://github.com/sinisterchipmunk/jax and see what it can do for you.

= rails-webgl

A WebGL framework for Rails. This is the official project spawned from my Rails-based demos, which you can read more about at http://github.com/sinisterchipmunk/webgl.

And so far, that's about all there is to say about this project. Check back soon when I have something you can actually use.

== Installation

Be aware that this gem is designed for Rails 3 applications. I have no idea whether it works as expected with Rails 2, and have no intention of finding out.

To install, simply add rails-webgl to your Gemfile:

gem 'rails-webgl'

== Usage

The simplest usage of this gem is to simply include the WebGL JavaScripts into your application layout:

<%=javascript_include_tag :webgl%>

At this point, you're totally ready to start using the JavaScript portion of this framework. See the TODO JavaScript API documentation for more information on that.

TODO To make the most of the Ruby portion of this framework, you need to ...

== Contributing to webgl

• 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) 2010 Colin MacKenzie IV. See LICENSE.txt for further details.