README.adoc

   1 = WeeChat
   2 :author: Sébastien Helleu
   3 :email: flashcode@flashtux.org
   4 :lang: en
   5
   6
   7 image:https://img.shields.io/badge/diaspora*-follow-blue.svg["Diaspora*", link="https://diasp.eu/u/weechat"]
   8 image:https://img.shields.io/badge/google%2B-follow-blue.svg["Google+", link="https://plus.google.com/+WeeChat"]
   9 image:https://img.shields.io/badge/devel%20blog-follow-blue.svg["Devel blog", link="https://weechat.org/blog/"]
  10 image:https://img.shields.io/badge/slant-recommend-28acad.svg["Slant", link="http://www.slant.co/topics/1323/~irc-clients-for-linux"]
  11 image:https://img.shields.io/badge/help-donate%20%E2%9D%A4-ff69b4.svg["Donate", link="https://weechat.org/donate/"]
  12
  13 image:https://travis-ci.org/weechat/weechat.svg?branch=master["Build Status", link="https://travis-ci.org/weechat/weechat"]
  14
  15 WeeChat (Wee Enhanced Environment for Chat) is a free chat client, fast and
  16 light, designed for many operating systems.
  17 It is highly customizable and extensible with scripts.
  18
  19 Homepage: https://weechat.org/
  20
  21 == Features
  22
  23 * *Modular chat client*: WeeChat has a lightweight core and optional plugins. All plugins (including IRC) are independent and can be unloaded.
  24 * *Multi-platform*: WeeChat runs on GNU/Linux, *BSD, GNU/Hurd, Mac OS X and Windows (Bash/Ubuntu and Cygwin).
  25 * *Multi-protocols*: WeeChat is designed to support multiple protocols by plugins, like IRC.
  26 * *Standards-compliant*: the IRC plugin is compliant with RFCs 1459, 2810, 2811, 2812 and 2813.
  27 * *Small, fast and very light*: the core is and should stay as light and fast as possible.
  28 * *Customizable and extensible*: there are a lot of options to customize WeeChat, and it is extensible with C plugins and scripts (Perl, Python, Ruby, Lua, Tcl, Scheme, JavaScript and PHP).
  29 * *Fully documented*: there is comprehensive documentation, which is translated into several languages.
  30 * *Developed from scratch*: WeeChat was built from scratch and is not based on any other client.
  31 * *Free software*: WeeChat is released under GPLv3.
  32
  33 image::https://weechat.org/media/images/screenshots/weechat/medium/weechat_2013-04-27_phlux_shadow.png[align="center"]
  34
  35 Other screenshots are on https://weechat.org/about/screenshots/[this page].
  36
  37 == Install
  38
  39 === Dependencies
  40
  41 Following packages are *required*:
  42
  43 * CMake
  44 * libncurses
  45 * libcurl
  46 * zlib
  47 * libgcrypt
  48
  49 Following packages are optional:
  50
  51 * for i18n: gettext
  52 * for SSL: gnutls, ca-certificates
  53 * for spell checking: aspell
  54 * for scripting: python, perl, ruby, lua, tcl, guile, libv8 (javascript), php
  55 * for building doc and man page: asciidoctor
  56 * for building tests: C++ compiler, CppUTest
  57
  58 For a complete list of dependencies and versions recommended, please look at
  59 https://weechat.org/files/doc/devel/weechat_user.en.html#dependencies[user's guide].
  60
  61 === Compile
  62
  63 WeeChat can be built with http://cmake.org/[CMake] (recommended) or autotools.
  64
  65 [NOTE]
  66 Only CMake is officially supported to build WeeChat. You should only use
  67 autotools if you are not able to use CMake. +
  68 Building with autotools requires more dependencies and is slower than with CMake.
  69
  70 * Installation in system directories (requires _root_ privileges):
  71
  72 ----
  73 $ mkdir build
  74 $ cd build
  75 $ cmake ..
  76 $ make
  77 $ sudo make install
  78 ----
  79
  80 * Installation in custom directory (for example your home):
  81
  82 ----
  83 $ mkdir build
  84 $ cd build
  85 $ cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/directory
  86 $ make
  87 $ make install
  88 ----
  89
  90 For more information or installation with autotools, please look at
  91 https://weechat.org/files/doc/devel/weechat_user.en.html#compile_with_autotools[user's guide].
  92
  93 === Run tests
  94
  95 Following packages are *required* to compile tests:
  96
  97 * libcpputest-dev
  98 * C++ compiler
  99
 100 Tests must be enabled when compiling WeeChat:
 101
 102 ----
 103 $ cmake .. -DENABLE_TESTS=ON
 104 ----
 105
 106 They can be launched after compilation from the build directory:
 107
 108 ----
 109 $ ctest -V
 110 ----
 111
 112 == Copyright
 113
 114 Copyright (C) 2003-2018 Sébastien Helleu <flashcode@flashtux.org>
 115
 116 This file is part of WeeChat, the extensible chat client.
 117
 118 WeeChat is free software; you can redistribute it and/or modify
 119 it under the terms of the GNU General Public License as published by
 120 the Free Software Foundation; either version 3 of the License, or
 121 (at your option) any later version.
 122
 123 WeeChat is distributed in the hope that it will be useful,
 124 but WITHOUT ANY WARRANTY; without even the implied warranty of
 125 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 126 GNU General Public License for more details.
 127
 128 You should have received a copy of the GNU General Public License
 129 along with WeeChat.  If not, see <http://www.gnu.org/licenses/>.