Commit 80e9cd7b60d98449e6deaff6983bedb810b10566

Authored by Matti Virkkunen
1 parent 3e5dce67

Include installation instructions for APT in readme.

Showing 1 changed file with 38 additions and 38 deletions
README.md
... ... @@ -5,36 +5,31 @@ libpurple (Pidgin, Finch) protocol plugin for [LINE](http://line.me/).
5 5  
6 6 ![Screenshot](http://i.imgur.com/By1yLXB.png)
7 7  
8   -Where are the binaries and packages?
9   -------------------------------------
  8 +Install via package manager (Ubuntu/Debian)
  9 +-------------------------------------------
10 10  
11   -I am not looking into "easy to install" options before I'm satisfied with the stability. I'd rather
12   -not have people who cannot figure out how to compile software by themselves be disappointed by an
13   -unstable plugin.
  11 +An APT repository is available for installing the plugin. The repository contains the purple-line
  12 +package itself, and the required Apache Thrift packages which are not properly packaged by either
  13 +distribution.
14 14  
15   -How to install
16   ---------------
  15 +* http://debian.altrepo.eu/ (main)
  16 +* http://debian.surlinter.net/ (mirror)
17 17  
18   -Make sure you have the required prerequisites:
  18 +For instructions for adding a custom repository on Ubuntu, see [the Ubuntu wiki](https://help.ubuntu.com/community/Repositories/Ubuntu).
19 19  
20   -* libpurple - Library that provides the core functionality of Pidgin and other compatible clients.
21   - Probably available from your package manager
22   -* thrift / libthrift - Apache Thrift compiler and C++ library. May be available from your package
23   - manager.
  20 +For Debian, see [the Debian wiki](https://www.debian.org/releases/), or just add the following line
  21 +to your `sources.list` file:
24 22  
25   -To install the plugin system-wide, run:
  23 + deb http://debian.altrepo.eu/ stable main
26 24  
27   - make
28   - sudo make install
  25 +On either distribution, after adding the repository, run the following commands to install the
  26 +plugin:
29 27  
30   -The makefile supports a flag THRIFT_STATIC=true which causes it to download and build a version of
31   -Thrift and statically link it. This should be convenient for people using one of the numerous
32   -distributions that do not package Thrift.
  28 + sudo apt-get update
  29 + sudo apt-get install purple-line
33 30  
34   -You can also install the plugin for your user only by replacing `install` with `user-install`.
35   -
36   -How to install (Arch Linux)
37   ----------------------------
  31 +Install from source (Arch Linux)
  32 +--------------------------------
38 33  
39 34 Arch Linux packages all the required dependencies, so you can install the plugin by simply typing:
40 35  
... ... @@ -42,24 +37,29 @@ Arch Linux packages all the required dependencies, so you can install the plugin
42 37 make
43 38 sudo make install
44 39  
45   -How to install (Ubuntu)
46   ------------------------
  40 +Install from source (any distribution)
  41 +--------------------------------------
  42 +
  43 +Make sure you have the required prerequisites installed:
47 44  
48   -Ubuntu does not currently package Thrift so it must be obtained elsewhere, or statically linked. To
49   -build the plugin with a statically linked Thrift library, type:
  45 +* libpurple - Library that provides the core functionality of Pidgin and other compatible clients.
  46 + Probably available from your package manager
  47 +* thrift - Apache Thrift compiler. May be available from your package manager.
  48 +* libthrift - Apache Thrift C++ library. May be available from your package manager.
  49 +
  50 +To install the plugin system-wide, run:
50 51  
51   - sudo apt-get install \
52   - libpurple-dev \
53   - libboost-dev libboost-test-dev \
54   - libboost-program-options-dev libboost-system-dev libboost-filesystem-dev libevent-dev \
55   - automake libtool flex bison pkg-config g++ libssl-dev
56   - make THRIFT_STATIC=true
57   - sudo make install THRIFT_STATIC=true
  52 + make
  53 + sudo make install
58 54  
59   -The installed packages include all the suggested dependencies from Thrift's website.
  55 +The makefile supports a flag THRIFT_STATIC=true which causes it to download and build a version of
  56 +Thrift and statically link it. This should be convenient for people using one of the numerous
  57 +distributions that do not package Thrift.
  58 +
  59 +You can also install the plugin for your user only by replacing `install` with `user-install`.
60 60  
61   -Implemented
62   ------------
  61 +Features implemented
  62 +--------------------
63 63  
64 64 * Logging in
65 65 * Authentication
... ... @@ -91,8 +91,8 @@ Implemented
91 91 * Audio (send/receive)
92 92 * Location (receive)
93 93  
94   -To do
95   ------
  94 +Features not yet implemented
  95 +----------------------------
96 96  
97 97 * Only fetch unseen messages, let a log plugin handle already seen messages
98 98 * Implement timeouts for faster reconnections
... ...