README.rdoc in remogatto-ffi-opengl-0.1.0 vs README.rdoc in remogatto-ffi-opengl-0.2.0
- old
+ new
@@ -3,40 +3,49 @@
http://github.com/remogatto/ffi-opengl/
== DESCRIPTION:
ffi-opengl is an autogenerated[1] ruby FFI interface towards OpenGL
-libraries (GL, GLU, GLUT).
+libraries (GL, GLU, GLUT). The FFI layer ensures compatibility among
+all Ruby implementation that support it. At the moment, this means
+that you can run the same ffi-opengl script with MRI Ruby and JRuby.
-ffi-opengl API aims to be a 1:1 translation of the OpenGL C API: don't
-expect idiomatic ruby inside!
+ffi-opengl API aims to be a 1:1 tranposition of the OpenGL C API:
+don't expect idiomatic ruby inside!
== FEATURES/PROBLEMS:
* Full [auto-generated] wrap of the OpenGL libraries.
-* No compilation needed.
-* Not yet tested on windows/macosx platforms
+* JRuby 1.3.0 compatible.
+
+* No need of opengl development libraries.
+
+* No compilation needed (if you use JRuby or you have ruby-ffi
+ installed on your system).
+
+* Not yet tested on windows platform.
+
== SYNOPSIS:
See the example in 'examples/' folder. For the API documentation
please refer to OpenGL reference pages.
== REQUIREMENTS:
-* ffi >= 0.3.0 (development version)
+* ffi >= 0.3.0
* OpenGL libraries >= 1.2
== DOWNLOAD/INSTALL:
To download and install the gem from github:
- [sudo] gem sources -a http://gems.github.com
+ [sudo] gem sources -a http://gems.github.com # needed only the first time
[sudo] gem install remogatto-ffi-opengl
To download the develpment trunk:
- git clone http://github.com/remogatto/ffi-opengl/tree/master
+ git clone http://github.com/remogatto/ffi-opengl.git
== LINKS:
1. http://kenai.com/projects/ruby-ffi/sources/swig-generator/show