annotate README @ 33:abe31282e2de

revised README
author Yoshiki Yazawa <yaz@cc.rim.or.jp>
date Sat, 10 May 2008 19:25:13 +0900
parents 73e817be3267
children 6774859df10b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
33
abe31282e2de revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 28
diff changeset
1 pidgin-twitter-0.6.0
17
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
26
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
7 plugin translates any @username and the sender name to the link to the
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
8 user respectively. pidgin-twitter also can play a sound when an
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
9 incoming message contains any recipient name or sender name which is
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
10 listed in the each dedicated lists.
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
11
26
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
12 *update*
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
13 From version 0.5.0, pidgin-twitter automatically escapes annoying
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
14 "pseudo command" in sending message. A pseudo command is a message
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
15 like "¤Ë¤Û¤ó¤´w" or "....w" and it will be wrongly interpreted as an
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
16 incomplete command message so that twitter gives us an error massage.
17
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 2. Dependency
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 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
21
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
22
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
23 3. How to build
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
24
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
25 Building pidgin-twitter plugin is very simple. Please do
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 ./configure
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
28 make
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
29 sudo make install
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
30
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
31
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
32 4. Usage
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
33
26
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
34 To enable pidgin-twitter, please check it "Enabled" in pidgin's
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
35 plugins window. If it is enabled, it replaces each @username string
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
36 and sender string with the link to the corresponding user, by
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
37 default. You can enable/disable these via plugin's configure window.
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
38
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
39 Play sound for matched recipients or sender is also enabled by
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
40 default, however it might not work until you specify user lists for
26
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
41 this feature.
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
42
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
43 Recipient list accommodates names of watched recipients. Usually, the
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
44 first name might be your user name. Sender list accommodates names of
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
45 watched senders, instead. These lists are independent to each other
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
46 so that you can maintain different groups to be watched. An user list
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
47 is a enumeration of usernames separated by a letter in ",:;". For
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
48 example, "foo bar" or "foo,bar" is a valid user list and a list like
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
49 "foo, bar" also works. This functionality is also able to be toggled
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
50 on/off via configuration window.
17
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 Event type of sound to play is also configurable. By default, the
26
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
53 "Pounce Default" sound is specified since it may not be disabled by
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
54 configuration in pidgin's preferences. You can specify other sounds,
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
55 but be aware, you have to enable the event type of sound which you
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
56 specified for pidgin-twitter in pidgin's preferences.
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
57
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
58 Escape pseudo command functionality is enabled by default. To disable
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
59 this feature, please uncheck it in the plugin configuration window. I
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
60 recommend you to leave it always enabled.
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
61
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
62
28
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
63 5. Histroy
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
64
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
65 0.4.0 (May 01 2008)
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
66 First public release.
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
67
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
68 0.5.0 (May 05 2008)
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
69 Added escape pseudo command functionality.
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
70
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
71 0.5.1 (May 05 2008)
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
72 Fixed a crash bug that each unload and reload pidgin-twitter cycle
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
73 resulted in crash.
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
74
33
abe31282e2de revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 28
diff changeset
75 0.6.0 (In near future in 2008)
abe31282e2de revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 28
diff changeset
76 Added letter counter.
abe31282e2de revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 28
diff changeset
77 "False positive oops message" suppression has been added. (in progress)
28
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
78
33
abe31282e2de revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 28
diff changeset
79
abe31282e2de revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 28
diff changeset
80 6. Acknowledgments
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
81
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
82 I got some valuable feedbacks from nosuke (@konosuke) and mojin
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
83 (@mojin).
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
84
33
abe31282e2de revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 28
diff changeset
85 The original letter counter has been developed by Dossy Shiobara in
abe31282e2de revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 28
diff changeset
86 convcharcount plugin.
abe31282e2de revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 28
diff changeset
87
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
88
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
89 Yoshiki Yazawa (@yazuuchi)
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
90 yaz@honeyplanet.jp