# -*- RD -*-
= README
== Ruby-GNOME2 -- Ruby bindings for GNOME-2.x
This is a set of bindings for the GNOME-2.x libraries to
use from Ruby 1.8.6, 1.8.7 and 1.9.1.
== Release packages
=== ruby-gtk2
* Ruby/GLib2: GLib 2.0.x or later
* Ruby/ATK: ATK 1.0.x or later
* Ruby/Pango: Pango 1.1.x or later
* Ruby/GdkPixbuf2: GTK+ 2.0.x or later
* Ruby/GTK2: GTK+ 2.0.x or later
=== ruby-gnome2-all
* ruby-gtk2
* Ruby/RSVG: librsvg 2.8.0 or later
* Ruby/Poppler: poppler-glib 0.8.0 or later
* Ruby/VTE VTE 0.12.1 or later
* Ruby/GtkSourceView2: GtkSourceView 2.0.0 or later
* Ruby/GIO2: GIO 2.16.x or later
=== Experimental / Incomplete:
* Ruby/GStreamer: GStreamer 0.10.x or later
* Ruby/GooCanvas: GooCanvas 0.8.0 or later
=== Deprecated
* Ruby/PanelApplet: gnome-panel 2.6.0 or later (deprecated since 0.16.0)
* Ruby/GConf2: GConf 2.0.x or later
* Ruby/GNOME2: libgnome-2.0.x, libgnomeui-2.0.x or later
* Ruby/GnomeCanvas2: libgnomecanvas-2.0.x or later
* Ruby/GnomePrint: libgnomeprint-2.8.x or later
* Ruby/GnomePrintUI: libgnomeprintui-2.6.x or later
* Ruby/GnomeVFS: GnomeVFS 2.0.x or later
* Ruby/GtkHtml2: GtkHtml2 2.0.x or later
* Ruby/GtkGLExt: GtkGLExt 1.0.3 or later
* Ruby/Libart2: libart_lgpl 2.3.12 or later
* Ruby/GtkSourceView: GtkSourceView 1.0.1 or later
* Ruby/Libglade2: Libglade 2.0.x or later
* Ruby/GtkMozEmbed: GtkMozEmbed (Mozilla 1.7.x or FireFox-1.0.x or later)
== Install
% ruby extconf.rb
% make
% sudo make install
To compile and install a particular sub-binding, you can add arguments:
% ruby extconf.rb [subdir]...
e.g.) ruby extconf.rb glib2 pango atk gdk_pixbuf2 gtk2
Or you can compile each sub-binding:
% cd <each sub-directory>
% ruby extconf.rb
% make
% sudo make install
=== extconf.rb options
: --ruby
ruby directory
: --topsrcdir
top source directory
: --topdir
top directory
: --strict
if some libraries fail to compile/install, "make"
command returns 1(exit 1)
=== Environment Variables
: CAIRO_PATH
rcairo path (for Win32).
=== Dependencies
You should install a sub-binding with its dependencies. The
current dependencies are:
: Ruby/GLib
none.
: Ruby/ATK
depends on Ruby/GLib.
: Ruby/Pango
depends on Ruby/GLib, rcairo(optional).
: Ruby/GdkPixbuf
depends on Ruby/GLib.
: Ruby/GTK
depends on Ruby/GLib, Ruby/ATK, Ruby/Pango,
Ruby/GdkPixbuf, rcairo(optional)
: Ruby/RSVG
depends on Ruby/GLib, Ruby/GdkPixbuf2.
: Ruby/Poppler
depends on Ruby/GLib, Ruby/GdkPixbuf(optional), rcairo(optional).
: Ruby/VTE
depends on Ruby/GTK.
: Ruby/GtkSourceView2
depends on Ruby/GTK.
: Ruby/GIO2
depends on Ruby/GLib.
=== Experimental
: Ruby/GStreamer
depends on Ruby/GLib.
: Ruby/GooCanvas
depends on Ruby/GTK.
=== Deprecated
: Ruby/PanelApplet
depends on Ruby/GTK (since libpanel-applet 2.25) or
Ruby/GNOME (before libpanel-applet 2.25).
: Ruby/Libart
depends on Ruby/GLib(Use mkmf-gnome2.rb only).
: Ruby/GConf
depends on Ruby/GLib.
: Ruby/GNOME
depends on Ruby/GnomeCanvas.
: Ruby/GnomeCanvas
depends on Ruby/GTK, Ruby/Libart.
: Ruby/GnomeVFS
depends on Ruby/GLib.
: Ruby/GnomePrint
depends on Ruby/GLib, Ruby/Pango, Ruby/Libart2.
: Ruby/GnomePrintUI
depends on Ruby/GTK, Ruby/GnomePrint.
: Ruby/GtkHtml2
depends on Ruby/GTK.
: Ruby/GtkGLExt
depends on Ruby/GTK, rbogl.
: Ruby/GtkSourceView
depends on Ruby/GTK.
: Ruby/Libglade
depends on Ruby/GTK, Ruby/GNOME(optional), REXML(optional).
== Bugs
Please report bugs either in our bug tracker
((<URL:http://sourceforge.net/tracker/?group_id=53614&atid=470969>))
or on the ruby-gnome2-devel-en / ruby-gnome2-devel-ja mailing list
((<URL:http://sourceforge.net/mail/?group_id=53614>))
== Copying
Copyright (c) 2002-2009 Ruby-GNOME2 Project Team
This program is free software.
You can distribute/modify this program under the terms of
the GNU LESSER GENERAL PUBLIC LICENSE Version 2.1.
== Project Website
((<URL:http://ruby-gnome2.sourceforge.jp/>))