README.adoc

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