Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/dequis/purple-facebook.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordequis <dx@dxzone.com.ar>2015-07-10 09:13:44 +0300
committerdequis <dx@dxzone.com.ar>2015-07-10 09:20:06 +0300
commit9faa20932d23c88271a2583b6dbe1e38643e6eb7 (patch)
tree75ee8a665c7c63ee570423ff5809f51d17e2331a
parent1d76c223ce5df70a1e171314fafc5f010393ed91 (diff)
README: Reorganize and clarify some stuff
Like, moving the windows instructions to the top.
-rw-r--r--README53
1 files changed, 41 insertions, 12 deletions
diff --git a/README b/README
index 6cb6337..1e46e5e 100644
--- a/README
+++ b/README
@@ -2,21 +2,56 @@ Purple Facebook implements the Facebook Messenger protocol into pidgin,
finch, and libpurple. While the primary implementation is for purple3,
this plugin is back-ported for purple2.
-## Building and Installing
+This is a replacement to the built-in "Facebook (XMPP)" protocol, which
+[has been deprecated](https://developers.facebook.com/docs/chat).
+
+## Basic usage
+
+1. Install the plugin (see the corresponding section below)
+2. Restart pidgin
+3. Add a new account or modify your existing one with the following details:
+
+ * Protocol: "Facebook" (**NOT** "Facebook (XMPP)")
+ * Username: Either your email, facebook username or phone will work. If you
+ had "username@chat.facebook.com", remove the "@chat.facebook.com" part.
+
+## Installing on windows
+
+1. Download: [libjson-glib-1.0.dll][dl1]
+2. Copy the downloaded `libjson-glib-1.0.dll` to `C:\Program Files\Pidgin`
+3. Download the latest `libfacebook.dll` from the [releases][dl2]
+4. Copy the downloaded `libfacebook.dll` to `C:\Program Files\Pidgin\plugins`
+
+Note: `Program Files` will be `Program Files (x86)` on 64-bit Windows.
+
+[dl1]: https://github.com/jgeboski/purple-facebook/releases/download/downloads/libjson-glib-1.0.dll
+[dl2]: https://github.com/jgeboski/purple-facebook/releases
+
+## Building and Installing on linux and other platforms
Make sure glib, json-glib, libpurple (pidgin), and zlib are installed
with their headers and development information. If these packages came
from the distribution's repository, they will likely need additional
development packages, usually suffixed with -dev.
+If the [release tarballs][dl2] are used:
+
+ $ tar xvf purple-facebook-*.tar.gz
+ $ cd purple-facebook-*
+ $ ./configure
+ $ make
+
+Otherwise, to build from this git repository, which additionally requires
+autoconf, automake and mercurial (for `update.sh`)
+
$ git clone https://github.com/jgeboski/purple-facebook.git
$ cd purple-facebook
$ ./autogen.sh
$ make
-With a "global" (or system) installation:
+With a "global" (or system) installation (usually to /usr/lib/purple-2/) as root:
- $ make install
+ # make install
Or with a "local" installation:
@@ -25,6 +60,9 @@ Or with a "local" installation:
## Building and Installing on Windows
+Note that this section is only relevant for development purposes. See
+"installing on windows" above to use the prebuilt dll.
+
These instructions are simply a continuation of the ones provided by
pidgin. Start by setting up a built pidgin source tree in
`$PIDGIN_DEV_ROOT/win32-dev/pidgin-2.10.11`.
@@ -50,15 +88,6 @@ Compile the plugin:
$ make -f Makefile.mingw install
$ cp win32-install-dir/plugins/libfacebook.dll C:/Program Files/Pidgin/plugins # alternatively: Program Files (x86)
-### Installing on Windows
-
-1. Download: [libjson-glib-1.0.dll](https://github.com/jgeboski/purple-facebook/releases/download/downloads/libjson-glib-1.0.dll)
-2. Copy the downloaded `libjson-glib-1.0.dll` to `C:\Program Files\Pidgin`
-3. Download the latest `libfacebook.dll` from the [releases](https://github.com/jgeboski/purple-facebook/releases)
-4. Copy the downloaded `libfacebook.dll` to `C:\Program Files\Pidgin\plugins`
-
-Note: `Program Files` will be `Program Files (x86)` on 64-bit Windows.
-
## Debugging
Before debugging can begin, the plugin must be compiled with debugging