annotate README @ 31888:b2d654b109b8

Correct attributions to Dustin Gathmann
author Ethan Blanton <elb@pidgin.im>
date Mon, 28 Mar 2011 19:57:20 +0000
parents 56042b2f8b64
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15937
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
1 Purple, Pidgin and Finch
0
a5ace2e037bc Tailorization
Tailor Script <tailor@pidgin.im>
parents:
diff changeset
2 ========================
15937
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
3 See AUTHORS and COPYRIGHT for the list of contributors.
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
4
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
5 libpurple is a library intended to be used by programmers seeking
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
6 to write an IM client that connects to many IM networks. It supports
16915
56042b2f8b64 s/Jabber/XMPP in user-visible places.
Richard Laager <rlaager@wiktel.com>
parents: 16728
diff changeset
7 AIM, ICQ, XMPP, MSN and Yahoo!, among others.
0
a5ace2e037bc Tailorization
Tailor Script <tailor@pidgin.im>
parents:
diff changeset
8
15937
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
9 Pidgin is an graphical IM client written in C which uses the GTK+
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
10 toolkit.
2608
cad63750f3bb [gaim-migrate @ 2621]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2536
diff changeset
11
15941
Richard Nelson <wabz@pidgin.im>
parents: 15937
diff changeset
12 Finch is a text-based IM client written in C which uses the ncurses
15937
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
13 toolkit.
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
14
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
15 These programs are not endorsed by, nor affiliated with, AOL nor any
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
16 other company in any way.
2862
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
17
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
18 BUILD
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
19 =====
0
a5ace2e037bc Tailorization
Tailor Script <tailor@pidgin.im>
parents:
diff changeset
20
2862
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
21 Read the 'INSTALL' file for more detailed directions.
0
a5ace2e037bc Tailorization
Tailor Script <tailor@pidgin.im>
parents:
diff changeset
22
15937
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
23 These programs use the standard ./configure ; make. You need to use
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
24 gmake, BSD make probably won't work. Remember, run ./configure --help
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
25 to see what build options are available.
2862
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
26
15937
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
27 In order to compile Pidgin you need to have GTK+ 2.0 installed (as
2862
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
28 well as the development files!). The configure script will fail if you
15941
Richard Nelson <wabz@pidgin.im>
parents: 15937
diff changeset
29 don't. If you don't have GTK+ 2.0 installed, you should install it
Richard Nelson <wabz@pidgin.im>
parents: 15937
diff changeset
30 using your distribution's package management tools.
0
a5ace2e037bc Tailorization
Tailor Script <tailor@pidgin.im>
parents:
diff changeset
31
15310
82a2e909e10e [gaim-migrate @ 18100]
Luke Schierer <lschiere@pidgin.im>
parents: 13632
diff changeset
32 For sound support, you also need gstreamer 0.10 or higher. For
82a2e909e10e [gaim-migrate @ 18100]
Luke Schierer <lschiere@pidgin.im>
parents: 13632
diff changeset
33 spellchecking support, you need libgtkspell (http://gtkspell.sf.net/).
82a2e909e10e [gaim-migrate @ 18100]
Luke Schierer <lschiere@pidgin.im>
parents: 13632
diff changeset
34 Your distro of choice probably already includes these, just be sure to
82a2e909e10e [gaim-migrate @ 18100]
Luke Schierer <lschiere@pidgin.im>
parents: 13632
diff changeset
35 install the development packages.
2862
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
36
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
37 RUN
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
38 ===
0
a5ace2e037bc Tailorization
Tailor Script <tailor@pidgin.im>
parents:
diff changeset
39
2862
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
40 You should run 'make install' as root to make sure plugins and other files
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
41 get installed into locations they want to be in. Once you've done that,
15937
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
42 you only need to run 'pidgin' or 'finch'.
0
a5ace2e037bc Tailorization
Tailor Script <tailor@pidgin.im>
parents:
diff changeset
43
16176
83ec0b408926 Beat some older documentation into submission.
Richard Laager <rlaager@wiktel.com>
parents: 15941
diff changeset
44 To get started, simply add a new account.
1400
476b24cdfa32 [gaim-migrate @ 1410]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 1161
diff changeset
45
16176
83ec0b408926 Beat some older documentation into submission.
Richard Laager <rlaager@wiktel.com>
parents: 15941
diff changeset
46 If you come across a bug, please report it at: http://pidgin.im
0
a5ace2e037bc Tailorization
Tailor Script <tailor@pidgin.im>
parents:
diff changeset
47
2862
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
48 PLUGINS
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
49 =======
2318
a7bfb5dfab25 [gaim-migrate @ 2328]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2142
diff changeset
50
15937
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
51 If you do not wish to enable the plugin support within Purple, run the
2318
a7bfb5dfab25 [gaim-migrate @ 2328]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2142
diff changeset
52 ./configure script with the --disable-plugins option and recompile your
a7bfb5dfab25 [gaim-migrate @ 2328]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2142
diff changeset
53 source code. This will prevent the ability to load plugins.
a7bfb5dfab25 [gaim-migrate @ 2328]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2142
diff changeset
54
15937
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
55 'make install' puts the plugins in $PREFIX/lib/purple (PREFIX being what
cc3c50816cc9 More gaim->whatever isms
Mark Doliner <mark@kingant.net>
parents: 15310
diff changeset
56 you specified when you ./configure'd - it defaults to /usr/local). Purple
16176
83ec0b408926 Beat some older documentation into submission.
Richard Laager <rlaager@wiktel.com>
parents: 15941
diff changeset
57 looks for the plugins in that directory by default. Plugins can be installed
83ec0b408926 Beat some older documentation into submission.
Richard Laager <rlaager@wiktel.com>
parents: 15941
diff changeset
58 per-user in ~/.purple/plugins as well. Pidgin and Finch also look in
83ec0b408926 Beat some older documentation into submission.
Richard Laager <rlaager@wiktel.com>
parents: 15941
diff changeset
59 $PREFIX/lib/pidgin and $PREFIX/lib/finch for UI-specific, respectively.
2862
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
60
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
61 To build a plugin from a .c file, put it in the plugins/ directory in
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
62 the source and run 'make filename.so', e.g. if you have the .c file
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
63 'kickass.c', put it in the plugins/ directory, and from that directory,
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
64 run 'make kickass.so'.
ad4057cb228f [gaim-migrate @ 2875]
Eric Warmenhoven <eric@warmenhoven.org>
parents: 2777
diff changeset
65