annotate README @ 30:e740ceed9337

tweaked descriptions

pidgin-twitter-0.5.1


1. What is this?

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

*update*
From version 0.5.0, pidgin-twitter automatically escapes annoying
"pseudo command" in sending message. A pseudo command is a message
like "¤Ë¤Û¤ó¤´w" or "....w" and it will be wrongly interpreted as an
incomplete command message so that twitter gives us an error massage.

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's
plugins window. If it is enabled, it replaces each @username string
and sender string with the link to the corresponding user, by
default. You can enable/disable these via plugin's 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.

Recipient list accommodates names of watched recipients. Usually, the
first name might be your user name. Sender list accommodates names of
watched senders, instead.  These lists are independent to each other
so that you can maintain different groups to be watched. 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 and a list like
"foo, bar" also works. This functionality is also able to be toggled
on/off via configuration window.

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

Escape pseudo command functionality is enabled by default. To disable
this feature, please uncheck it in the plugin configuration window. I
recommend you to leave it always enabled.


5. Histroy

0.4.0 (May 01 2008)
First public release.

0.5.0 (May 05 2008)
Added escape pseudo command functionality.

0.5.1 (May 05 2008)
Fixed a crash bug that each unload and reload pidgin-twitter cycle
resulted in crash.


6. Acknowledgment

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


Yoshiki Yazawa (@yazuuchi)
[e-mail]