Add 'Installation' section to README
This commit is contained in:
parent
32fbe59f01
commit
0637ee0401
21
README.md
21
README.md
|
@ -3,18 +3,16 @@
|
||||||
|
|
||||||
Cardie is a multi-protocol chat program based on [Caya](https://github.com/Augustolo/Caya).
|
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
|
![Screenshot](data/screenshots/update-3.png)
|
||||||
library used by [Pidgin](https://pidgin.im/).
|
|
||||||
|
|
||||||
Protocols natively supported are:
|
It can use protocols through native add-ons as well as through libpurple,
|
||||||
- IRC
|
the library used by [Pidgin](https://pidgin.im/).
|
||||||
- XMPP
|
|
||||||
|
Protocols natively supported include IRC and XMPP.
|
||||||
|
|
||||||
Protocols generally supported through libpurple include GroupWise, Zephyr, and
|
Protocols generally supported through libpurple include GroupWise, Zephyr, and
|
||||||
[others through plugins](https://pidgin.im/plugins/?type=Protocol).
|
[others through plugins](https://pidgin.im/plugins/?type=Protocol).
|
||||||
|
|
||||||
![Screenshot](data/screenshots/update-3.png)
|
|
||||||
|
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
You can make Cardie and its protocols with:
|
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.
|
`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
|
## License
|
||||||
Cardie itself is under the MIT license, but licenses vary for the included
|
Cardie itself is under the MIT license, but licenses vary for the included
|
||||||
libraries and add-ons.
|
libraries and add-ons.
|
||||||
|
|
Ŝarĝante…
Reference in New Issue