From 40894df7789ee8064d9e25adb2d22091e16df5f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A5vard=20Pettersson?= Date: Sat, 19 Jan 2019 14:41:35 +0100 Subject: [PATCH] readme: improve build & install instructions --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b275c24..86487dc 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,10 @@ Standard][3]. - File transfer ## Installation -Tox-WeeChat is tested with [WeeChat][2] 2.3 and [TokTok c-toxcore][5] 0.2.8. -It also requires CMake 2.8.12 or newer to be built. Installation is fairly -simple; after getting the source code, compile and install with CMake: +Tox-WeeChat requires [WeeChat][2] (tested with version 2.3) and [TokTok +c-toxcore][5] (tested with version 0.2.8). CMake 2.8.12 or newer is also +required to build. Installation is fairly simple; after getting the source +code, compile and install using CMake: $ mkdir build && cd build $ cmake -DPLUGIN_PATH=~/.weechat/plugins .. @@ -27,6 +28,10 @@ simple; after getting the source code, compile and install with CMake: This installs the plugin binary `tox.so` to the recommended location `~/.weechat/plugins`. The default location is `/usr/local/lib/weechat/plugins`. +If WeeChat or toxcore are installed in a non-standard location, you can try +specifying `CMAKE_PREFIX_PATH` to find them; see [.travis.yml](.travis.yml) for +an example. + ## Usage - 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 if you installed