README

   1 # Purple, Pidgin and Finch
   2 See AUTHORS and COPYRIGHT for the list of contributors.
   3
   4 libpurple is a library intended to be used by programmers seeking
   5 to write an IM client that connects to many IM networks.  It supports
   6 AIM, ICQ, and XMPP, among others.
   7
   8 Pidgin is a graphical IM client written in C which uses the GTK+
   9 toolkit.
  10
  11 Finch is a text-based IM client written in C which uses the ncurses
  12 toolkit.
  13
  14 These programs are not endorsed by, nor affiliated with, AOL nor any
  15 other company in any way.
  16
  17 ## BUILD
  18
  19 Pidgin uses [meson](https://mesonbuild.com) as a build system.
  20
  21 You can quickly build Pidgin with the following commands
  22
  23     meson build
  24     cd build
  25     ninja
  26     sudo ninja install
  27
  28 There are quite a few options for the build that you can view by looking at `meson_options.txt`.  You can specify the options when running meson like the following:
  29
  30     meson -Ddebug=true build
  31
  32 If you've already ran meson you can use `meson configure`
  33
  34     cd build
  35     meson configure -Ddebug=true
  36
  37 ## RUN
  38
  39 Currently Pidgin can not be run from a build directory which means you must
  40 install it first.  Once you've done that, you only need to run 'pidgin' or
  41 'finch'.
  42
  43 To get started, simply add a new account.
  44
  45 If you come across a bug, please report it at: https://developer.pidgin.im/
  46
  47 ## PLUGINS
  48
  49 If you do not wish to enable the plugin support within Purple, run meson with
  50 `-Dplugins=false` or if you've already ran meson use
  51 `meson configure -Dplugins=false` from the build directory.  This will prevent
  52 the ability to load plugins.
  53
  54 `ninja install` puts the plugins in `$PREFIX/lib/purple` (PREFIX being what
  55 you specified when you ran meson.  It defaults to `/usr/local`). Purple
  56 looks for the plugins in that directory by default.  Plugins can be installed
  57 per-user in `~/.purple/plugins` as well.  Pidgin and Finch also look in
  58 `$PREFIX/lib/pidgin` and `$PREFIX/lib/finch` for UI-specific, respectively.
  59
  60 ## Developing
  61
  62 There is a ton of information on developing Pidgin available at
  63 [developer.pidgin.im](https://developer.pidgin.im).
  64
  65 To generate the documentation locally you can pass `-Ddoc=true` to `meson` or
  66 `meson configure` which will build the `gtk-docs` for everything.