From 210a644c9d747c48c0155aecc446c3a4c1946ed7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A5vard=20Pettersson?= Date: Wed, 26 Aug 2015 20:11:57 +0200 Subject: [PATCH] Update README.md --- README.md | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 1edf28d..09c5ccb 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,10 @@ -Tox-WeeChat -=========== +# Tox-WeeChat Tox-WeeChat is a [Tox][1] protocol plugin for [WeeChat][2]. It is functional, but lacks certain features like Tox DNS. Current build status: [![Build Status](https://travis-ci.org/haavardp/tox-weechat.svg?branch=master)][3] -Features --------- +## Features Below is a list of implemented features, as well as a rough roadmap for the future. @@ -21,12 +19,8 @@ future. - [ ] WeeChat `/upgrade` - [ ] Audio/video -Installation ------------- -> Tox-WeeChat is available in the [AUR][4] and the [[haavard]][5] pacman -repository. - -Tox-WeeChat requires [WeeChat][2] >= 1.0.1 and the latest-ish [libtoxcore][6]. +## Installation +Tox-WeeChat requires [WeeChat][2] >= 1.0.1 and the latest-ish [toxcore][4]. It also requires CMake to be built. Installation is fairly simple; after getting the source, compile and install using CMake: @@ -37,8 +31,7 @@ getting the source, compile and install using CMake: This installs the plugin binary `tox.so` to the recommended location `~/.weechat/plugins`. The default location is `/usr/local/lib/weechat/plugins`. -Usage ------ +## Usage - If the plugin does not load automatically, load it with `/plugin load tox`. You may have to specify the full path to the plugin binary. - Create a new profile with `/tox create `. The data file is @@ -83,7 +76,5 @@ along with Tox-WeeChat. If not, see . [1]: http://tox.im [2]: http://weechat.org [3]: https://travis-ci.org/haavardp/tox-weechat -[4]: https://aur.archlinux.org/packages/tox-weechat-git -[5]: https://haavard.me/archlinux -[6]: https://github.com/irungentoo/toxcore +[4]: https://github.com/irungentoo/toxcore