*** Plucked rev 602ee3404d02198f2a1430c98ac52ae487a0729c (darkrain42@pidgin.im):
[pidgin-git.git] / README
blobc7ca60de7f920deda047d49aff8760ce7b97d3e0
1 Purple, Pidgin and Finch
2 ========================
3 See AUTHORS and COPYRIGHT for the list of contributors.
5 libpurple is a library intended to be used by programmers seeking
6 to write an IM client that connects to many IM networks.  It supports
7 AIM, ICQ, XMPP, MSN and Yahoo!, among others.
9 Pidgin is an graphical IM client written in C which uses the GTK+
10 toolkit.
12 Finch is a text-based IM client written in C which uses the ncurses
13 toolkit.
15 These programs are not endorsed by, nor affiliated with, AOL nor any
16 other company in any way.
18 BUILD
19 =====
21 Read the 'INSTALL' file for more detailed directions.
23 These programs use the standard ./configure ; make. You need to use
24 gmake, BSD make probably won't work. Remember, run ./configure --help
25 to see what build options are available.
27 In order to compile Pidgin you need to have GTK+ 2.0 installed (as
28 well as the development files!). The configure script will fail if you
29 don't.  If you don't have GTK+ 2.0 installed, you should install it
30 using your distribution's package management tools.
32 For sound support, you also need gstreamer 0.10 or higher. For
33 spellchecking support, you need libgtkspell (http://gtkspell.sf.net/).
34 Your distro of choice probably already includes these, just be sure to
35 install the development packages.
37 RUN
38 ===
40 You should run 'make install' as root to make sure plugins and other files
41 get installed into locations they want to be in. Once you've done that,
42 you only need to run 'pidgin' or 'finch'.
44 To get started, simply add a new account.
46 If you come across a bug, please report it at: http://pidgin.im
48 PLUGINS
49 =======
51 If you do not wish to enable the plugin support within Purple, run the
52 ./configure script with the --disable-plugins option and recompile your
53 source code.  This will prevent the ability to load plugins.
55 'make install' puts the plugins in $PREFIX/lib/purple (PREFIX being what
56 you specified when you ./configure'd - it defaults to /usr/local). Purple
57 looks for the plugins in that directory by default.  Plugins can be installed
58 per-user in ~/.purple/plugins as well.  Pidgin and Finch also look in
59 $PREFIX/lib/pidgin and $PREFIX/lib/finch for UI-specific, respectively.
61 To build a plugin from a .c file, put it in the plugins/ directory in
62 the source and run 'make filename.so', e.g. if you have the .c file
63 'kickass.c', put it in the plugins/ directory, and from that directory,
64 run 'make kickass.so'.