emdee/tox-weechat
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Håvard Pettersson 2015-08-26 20:11:57 +02:00
parent d27f817777
commit 210a644c9d
1 changed files with 6 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,12 +1,10 @@
Tox-WeeChat # Tox-WeeChat
===========
Tox-WeeChat is a [Tox][1] protocol plugin for [WeeChat][2]. It is functional, Tox-WeeChat is a [Tox][1] protocol plugin for [WeeChat][2]. It is functional,
but lacks certain features like Tox DNS. but lacks certain features like Tox DNS.
Current build status: [![Build Status](https://travis-ci.org/haavardp/tox-weechat.svg?branch=master)][3] 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 Below is a list of implemented features, as well as a rough roadmap for the
future. future.
@ -21,12 +19,8 @@ future.
- [ ] WeeChat `/upgrade` - [ ] WeeChat `/upgrade`
- [ ] Audio/video - [ ] Audio/video
Installation ## Installation
------------ Tox-WeeChat requires [WeeChat][2] >= 1.0.1 and the latest-ish [toxcore][4].
> 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].
It also requires CMake to be built. Installation is fairly simple; after It also requires CMake to be built. Installation is fairly simple; after
getting the source, compile and install using CMake: 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 This installs the plugin binary `tox.so` to the recommended location
`~/.weechat/plugins`. The default location is `/usr/local/lib/weechat/plugins`. `~/.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`. - 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. You may have to specify the full path to the plugin binary.
- Create a new profile with `/tox create <profile name>`. The data file is - Create a new profile with `/tox create <profile name>`. The data file is
@ -83,7 +76,5 @@ along with Tox-WeeChat. If not, see <http://www.gnu.org/licenses/>.
[1]: http://tox.im [1]: http://tox.im
[2]: http://weechat.org [2]: http://weechat.org
[3]: https://travis-ci.org/haavardp/tox-weechat [3]: https://travis-ci.org/haavardp/tox-weechat
[4]: https://aur.archlinux.org/packages/tox-weechat-git [4]: https://github.com/irungentoo/toxcore
[5]: https://haavard.me/archlinux
[6]: https://github.com/irungentoo/toxcore