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/doc/user/#plugins[plugins]. All plugins (including https://weechat.org/doc/user/#irc[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/language/perl/[Perl], https://weechat.org/scripts/language/python/[Python], https://weechat.org/scripts/language/ruby[Ruby], https://weechat.org/scripts/language/lua/[Lua], https://weechat.org/scripts/language/tcl/[Tcl], https://weechat.org/scripts/language/guile/[Scheme], https://weechat.org/scripts/language/javascript/[JavaScript] and https://weechat.org/scripts/language/php/[PHP]).
  32 * *Fully documented*: there is comprehensive https://weechat.org/doc/[documentation], which is https://weechat.org/doc/dev/#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 == Installation
  41
  42 WeeChat can be installed using your favorite package manager (recommended) or by compiling it yourself.
  43
  44 For detailed instructions, please check the https://weechat.org/doc/user/#install[WeeChat user's guide].
  45
  46 == Copyright
  47
  48 Copyright (C) 2003-2023 Sébastien Helleu <flashcode@flashtux.org>
  49
  50 This file is part of WeeChat, the extensible chat client.
  51
  52 WeeChat is free software; you can redistribute it and/or modify
  53 it under the terms of the GNU General Public License as published by
  54 the Free Software Foundation; either version 3 of the License, or
  55 (at your option) any later version.
  56
  57 WeeChat is distributed in the hope that it will be useful,
  58 but WITHOUT ANY WARRANTY; without even the implied warranty of
  59 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  60 GNU General Public License for more details.
  61
  62 You should have received a copy of the GNU General Public License
  63 along with WeeChat.  If not, see <https://www.gnu.org/licenses/>.