comparison README @ 17:21f27858e155 0.4.0

added README

17:21f27858e155

pidgin-twitter-0.4.0


1. What is this?

pidgin-twitter is a pidgin plugin to help twittering via pidgin. This
plugin translates an @username string and sender string to the link to
the user, respectively. It also can play a sound when an incoming
message contains any recipient name or sender name listed in the
each dedicated lists.


2. Dependency

This plugin requires pidgin 2.4.0 or newer and glib-2.14.0 or newer.


3. How to build

Building pidgin-twitter plugin is very simple. Please do

./configure
make
sudo make install


4. Usage

To enable pidgin-twitter, please check it "Enabled" in pidgin plugins
window. If it is enabled, it replaces sender and each @username string
to the link to the corresponding user by default. You can
enable/disable these via configure window.

Play sound for matched recipients or sender is also enabled by
default, however it might not work until you specify user lists for
this feature. An user list is a enumeration of usernames separated by
a letter in " ,:;". For example, "foo bar" or "foo,bar" is a valid
user list. A list like "foo, bar" also works. Recipient list and
sender list are independent to each other so that you can maintain
different "watch list" for recipients and senders. This functionality
is also able to be toggled respectively via configuration window.

Event type of sound to play is also configurable. By default, the
"Pounce Default" sound is specified as it may not be disabled by
configuration in pidgin preferences. You can specify other sounds, but
be aware, you have to enable the event type of sound you specified for
pidgin-twitter in pidgin's preference.


5. Acknowledgment

I got some valuable feedbacks from nosuke (@konosuke) and mojin
(@mojin).


Yoshiki Yazawa (@yazuuchi)
[e-mail]