README for libdmtx-ruby version 0.7.0 - March 2, 2009
-----------------------------------------------------------------

libdmtx-ruby is a Ruby wrapper for libdmtx that was written by
Romain Goyet and is distributed as part of the libdmtx package.


1. Setup
-----------------------------------------------------------------

This Ruby wrapper relies on RMagick, and of course on libdmtx.

  1) Install RMagick : http://rmagick.rubyforge.org/

  2) Build libdmtx (./configure --prefix=/a/given/path )

  3) ruby extconf.rb --with-dmtx-dir=/a/given/path (same as step 2)

  4) make clean

  5) make


2. Usage
-----------------------------------------------------------------

Once the plug-in is built, you can toy around with the "test.rb"
sample script. It demonstrates both reading and writing.

Reading : ruby test.rb /path/to/an/image.file
Writing : ruby test.rb (It'll write something to "output.png")


3. This Document
-----------------------------------------------------------------

This document is derived from the wiki page located at:

  http://libdmtx.wiki.sourceforge.net/libdmtx+ruby+wrapper

If you find an error or have additional helpful information,
please edit the wiki directly with your updates.
