README for libdmtx-ruby version 0.7.2 - September 4, 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. libdmtx Installation
-----------------------------------------------------------------

libdmtx must be installed on your system before installing and
running the Ruby wrapper. Refer to the General Instructions for
this.


2. RMagick Installation
-----------------------------------------------------------------

In addition to libdmtx, the libdmtx Ruby wrapper also relies on
RMagick, available at:

  http://rmagick.rubyforge.org/


3. libdmtx-ruby Installation
-----------------------------------------------------------------

  $ ruby extconf.rb --with-dmtx-dir=/same/path/as/libdmtx
  $ make clean
  $ make


4. 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 will write something to "output.png".


5. This Document
-----------------------------------------------------------------

This document is derived from the wiki page located at:

  http://libdmtx.wikidot.com/libdmtx-ruby-wrapper

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