From 0637ee0401918e775c39b52c2266c89d2d39785e Mon Sep 17 00:00:00 2001 From: Jaidyn Ann Date: Wed, 18 Aug 2021 15:59:44 -0500 Subject: [PATCH] Add 'Installation' section to README --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d0ace5a..8cdc14c 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,16 @@ Cardie is a multi-protocol chat program based on [Caya](https://github.com/Augustolo/Caya). -It can use native protocol add-ons and protocols supported by libpurple, the -library used by [Pidgin](https://pidgin.im/). +![Screenshot](data/screenshots/update-3.png) -Protocols natively supported are: -- IRC -- XMPP +It can use protocols through native add-ons as well as through libpurple, +the library used by [Pidgin](https://pidgin.im/). + +Protocols natively supported include IRC and XMPP. Protocols generally supported through libpurple include GroupWise, Zephyr, and [others through plugins](https://pidgin.im/plugins/?type=Protocol). -![Screenshot](data/screenshots/update-3.png) - ## Building You can make Cardie and its protocols with: @@ -30,6 +28,15 @@ Cardie itself requires the `expat_devel` package, the XMPP protocol requires `glib2_devel`― though it's worth noting that libpurple doesn't work on x86_gcc2. +## Installation +Protocol add-ons can be installed in any add-ons directory under `cardie` +(i.e., `~/config/non-packaged/add-ons/cardie/`) or in the binary's CWD +(`./cardie/`). + +libpurple plugins can be installed to any lib directory under `purple-2` +(i.e., `~/config/non-packaged/lib/purple-2/`). + + ## License Cardie itself is under the MIT license, but licenses vary for the included libraries and add-ons.