D-BUS/Ruby
==========

Prerequisites for building
--------------------------

  * Ruby 1.8 or newer + headers
  * D-BUS library 0.22 or newer + headers
  * D-BUS GLIB2 library + headers
  * Ruby GLIB2 bindings

Build + Install
---------------

D-BUS/Ruby includes setup.rb for easy building and installation. To
build and install in one step:

  $ ruby setup.rb

Building
--------

If you just want to build:

  $ ruby setup.rb config
  $ ruby setup.rb setup
  
Installing
----------

To install a previously built source tree:

  $ ruby setup.rb install

Using
-----

The Ruby bindings cover approximately the same amount of D-BUS functionality as
the Python bindings, I used dbus_bindings.pyx as a guide to work from.

The API exposed is virtually identical to the Python bindings.

See the examples/ directory for more examples.

Tip:
  Set the environment variable DBUS_VERBOSE=1 to get verbose D-BUS output for
  your application.

Documentation
-------------

RDoc coverage exists for all publically exposed API methods.
To generate the documentation, run:

	$ ./tools/genrdoc


Bugs/Issues
-----------

If you run into any issues, please report them to the DBus/Ruby
bug tracker.

  http://rubyforge.org/tracker/?group_id=463

Thanks!
