annotate README @ 17:21f27858e155 0.4.0

added README
author Yoshiki Yazawa <yaz@cc.rim.or.jp>
date Thu, 01 May 2008 19:10:51 +0900
parents
children 3c45a1bc40a5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
1 pidgin-twitter-0.4.0
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
2
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
3
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
4 1. What is this?
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
5
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
6 pidgin-twitter is a pidgin plugin to help twittering via pidgin. This
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
7 plugin translates an @username string and sender string to the link to
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
8 the user, respectively. It also can play a sound when an incoming
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
9 message contains any recipient name or sender name listed in the
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
10 each dedicated lists.
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
11
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
12
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
13 2. Dependency
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
14
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
15 This plugin requires pidgin 2.4.0 or newer and glib-2.14.0 or newer.
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
16
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
18 3. How to build
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
19
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
20 Building pidgin-twitter plugin is very simple. Please do
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
21
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
22 ./configure
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
23 make
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
24 sudo make install
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
25
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
26
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
27 4. Usage
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
28
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
29 To enable pidgin-twitter, please check it "Enabled" in pidgin plugins
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
30 window. If it is enabled, it replaces sender and each @username string
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
31 to the link to the corresponding user by default. You can
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
32 enable/disable these via configure window.
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
33
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
34 Play sound for matched recipients or sender is also enabled by
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
35 default, however it might not work until you specify user lists for
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
36 this feature. An user list is a enumeration of usernames separated by
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
37 a letter in " ,:;". For example, "foo bar" or "foo,bar" is a valid
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
38 user list. A list like "foo, bar" also works. Recipient list and
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
39 sender list are independent to each other so that you can maintain
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
40 different "watch list" for recipients and senders. This functionality
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
41 is also able to be toggled respectively via configuration window.
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
42
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
43 Event type of sound to play is also configurable. By default, the
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
44 "Pounce Default" sound is specified as it may not be disabled by
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
45 configuration in pidgin preferences. You can specify other sounds, but
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
46 be aware, you have to enable the event type of sound you specified for
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
47 pidgin-twitter in pidgin's preference.
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
48
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
49
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
50 5. Acknowledgment
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
51
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
52 I got some valuable feedbacks from nosuke (@konosuke) and mojin
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
53 (@mojin).
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
54
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
55
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
56 Yoshiki Yazawa (@yazuuchi)
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
57 yaz@honeyplanet.jp