Added README.md and LICENSE.
This commit is contained in:
parent
a3aae117ab
commit
a522266c3f
2 changed files with 63 additions and 0 deletions
42
README.md
Normal file
42
README.md
Normal file
|
@ -0,0 +1,42 @@
|
|||
Tox-WeeChat
|
||||
===========
|
||||
|
||||
Tox-WeeChat is a C plugin for the [WeeChat][1] chat client that enables it to connect to the [Tox][2] network. It is functional, but not intended for regular use yet, as it lacks a ton of features.
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Tox-WeeChat requires [libtoxcore][3] to work. After getting it, install Tox-WeeChat like this:
|
||||
|
||||
git clone https://github.com/haavardp/tox-weechat.git
|
||||
cd tox-weechat
|
||||
mkdir build
|
||||
cd build
|
||||
|
||||
cmake ..
|
||||
make install
|
||||
|
||||
This places `tox.so` in `~/.weechat/plugins`.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
In WeeChat, load the plugin: `/plugin load tox`. You should get a new buffer called tox. This is the core Tox buffer, where output from Tox commands will print.
|
||||
|
||||
- To change your name, `/name <new name>`.
|
||||
- Get your Tox address with `/myaddress`.
|
||||
- To add friends or respond to friend requests, `/help friend` will get you started.
|
||||
- Message a friend with `/msg <friend number>`. Get their friend number with `/friend`.
|
||||
|
||||
That's pretty much all that's implemented for now.
|
||||
|
||||
License
|
||||
---------
|
||||
|
||||
Tox-WeeChat is licensed under the MIT license. For more information, see the LICENSE file.
|
||||
|
||||
Copyright (C) 2014 Håvard Pettersson <haavard.pettersson@gmail.com>.
|
||||
|
||||
[1]: http://weechat.org
|
||||
[2]: http://tox.im
|
||||
[3]: https://github.com/irungentoo/toxcore
|
Loading…
Add table
Add a link
Reference in a new issue