Added README.md and LICENSE.
This commit is contained in:
parent
a3aae117ab
commit
a522266c3f
21
LICENSE
Normal file
21
LICENSE
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2014 Håvard Pettersson <haavard.pettersson@gmail.com>
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in
|
||||||
|
all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
|
THE SOFTWARE.
|
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…
Reference in New Issue
Block a user