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

Update README links and information

This commit is contained in:
Håvard Pettersson 2017-02-03 16:06:24 -08:00
parent 8743350029
commit 3735c38adf
1 changed files with 13 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -1,26 +1,20 @@
# 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. but lacks certain features that might be expected of a full-fledged Tox client.
Current build status: [![Build Status](https://travis-ci.org/haavardp/tox-weechat.svg?branch=master)][3] [![Build Status](https://travis-ci.org/haavard/tox-weechat.svg?branch=master)][3]
## Features ## Features
Below is a list of implemented features, as well as a rough roadmap for the - One-to-one chats
future. - Group chats (text only)
- Proxy support
- [x] One-to-one chats - Multiple profiles
- [x] Group chats (text only) - Encrypted save files
- [x] Proxy support
- [x] Multiple profiles
- [x] Encrypted save files
- [ ] File transfer
- [ ] WeeChat `/upgrade`
- [ ] Audio/video
## Installation ## Installation
Tox-WeeChat requires [WeeChat][2] >= 1.5 and the latest-ish [toxcore][4]. It Tox-WeeChat is tested with [WeeChat][2] 1.7 and [TokTok c-toxcore][4] 0.1.6.
also requires CMake to be built. Installation is fairly simple; after getting It also requires CMake 2.8.11 or later to be built. Installation is fairly
the source, compile and install using CMake: simple; after getting the source code, compile and install with CMake:
$ mkdir build && cd build $ mkdir build && cd build
$ cmake -DPLUGIN_PATH=~/.weechat/plugins .. $ cmake -DPLUGIN_PATH=~/.weechat/plugins ..
@ -40,7 +34,6 @@ This installs the plugin binary `tox.so` to the recommended location
`/set tox.*` for a list of options. `/set tox.*` for a list of options.
### Common issues ### Common issues
#### Long Tox names messing up WeeChat layout #### Long Tox names messing up WeeChat layout
Tox allows names up to 128 bytes long. To prevent long names from taking all Tox allows names up to 128 bytes long. To prevent long names from taking all
your screen space, you can set the following options in WeeChat: your screen space, you can set the following options in WeeChat:
@ -71,8 +64,8 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with Tox-WeeChat. If not, see <http://www.gnu.org/licenses/>. along with Tox-WeeChat. If not, see <http://www.gnu.org/licenses/>.
[1]: http://tox.im [1]: http://tox.chat
[2]: http://weechat.org [2]: http://weechat.org
[3]: https://travis-ci.org/haavardp/tox-weechat [3]: https://travis-ci.org/haavard/tox-weechat
[4]: https://github.com/irungentoo/toxcore [4]: https://github.com/TokTok/c-toxcore