README.rdoc in remogatto-ffi-generator-0.1.0 vs README.rdoc in remogatto-ffi-generator-0.2.0
- old
+ new
@@ -3,28 +3,29 @@
http://github.com/remogatto/ffi-generator/tree/master
== DESCRIPTION:
ffi-generator is a ruby-ffi wrapper code generator based on SWIG
-interfaces.
+interface files.
ffi-generator is able to traverse a XML parse tree file generated by
-SWIG and to produce a ruby file with ruby-ffi wrapper code inside.
+SWIG and to produce a ruby-ffi interface file from it.
ffi-generator is shipped with a command line tool (ffi-gen) and a rake
task that automates the code generation process.
ffi-generator XML capabilities are provided by nokogiri.
== FEATURES/PROBLEMS:
-* support for
+* The program is able to generate:
* all C native types
* #define constants
* typedefs
- * struct, union, array and enum types
-* naive indentation of the generated code
+ * struct, union, array and enum types
+ * callbacks (pointers to functions)
+* Naive indentation of the generated code
== SYNOPSIS:
From command line:
@@ -38,10 +39,17 @@
== REQUIREMENTS:
* rake >= 0.8.3
* nokogiri >= 1.1.1
-== INSTALL:
+== DOWNLOAD/INSTALL:
+
+To download and install the gem from github:
+
+ [sudo] gem sources -a http://gems.github.com
+ [sudo] gem install remogatto-ffi-generator
+
+To download the develpment trunk:
git clone git://github.com/remogatto/ffi-generator.git
== EXAMPLES: