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

Update README.md

This commit is contained in:
Håvard Pettersson 2014-09-11 04:06:20 +02:00
parent 29fd690b72
commit 26aa49a9bd
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -11,17 +11,18 @@ Tox-WeeChat requires [libtoxcore][3] (and WeeChat) to work. After getting them,
$ git clone https://github.com/haavardp/tox-weechat.git
$ cd tox-weechat
$ mkdir build && cd build
Now, depending on where you want to install the plugin binary:
- To install to `~/.weechat/plugins` (recommended): `cmake -DHOME_FOLDER_INSTALL=ON ..`
- To install to `/usr/local/lib/weechat/plugins`: `cmake ..`
- To install to `/usr/lib/weechat/plugins`: `cmake -DCMAKE_INSTALL_PREFIX=/usr ..`
- To install somewhere else: `cmake -DINSTALL_PATH=/some/path ..`
Next, install the plugin. You may need sudo for the last command, depending on install location.
$ cmake -DHOME_FOLDER_INSTALL=ON ..
$ make
$ make install
This installs the plugin binary `tox.so` in the recommended location `~/.weechat/plugins`. To install the plugin somewhere else, replace the cmake command above with either of these:
- To install to `/usr/local/lib/weechat/plugins`: `cmake ..`
- To install to `/usr/lib/weechat/plugins`: `cmake -DCMAKE_INSTALL_PREFIX=/usr ..`
- To install a custom path: `cmake -DINSTALL_PATH=/some/path ..`
You may also need to `sudo make install`, depending on permissions.
Usage
-----
In WeeChat, load the plugin: `/plugin load tox`. In cases where WeeChat can't find the plugin, try specifying the full path to the binary. You should get a new buffer called tox. This is the core Tox buffer, where output from commands will appear.