Awesome Open Source
Awesome Open Source

:author: Sébastien Helleu ✉️ [email protected] :lang: en

pass:[

] image:https://weechat.org/media/images/weechat_logo_large.png[align="center"] pass:[

]

image:https://img.shields.io/badge/diaspora*-follow-blue.svg["Diaspora*", link="https://diasp.eu/u/weechat"] image:https://img.shields.io/badge/mastodon-follow-blue.svg["Mastodon", link="https://hostux.social/@weechat"] image:https://img.shields.io/badge/twitter-follow-blue.svg["Twitter", link="https://twitter.com/WeeChatClient"] image:https://img.shields.io/badge/devel%20blog-follow-blue.svg["Devel blog", link="https://blog.weechat.org/"] image:https://img.shields.io/badge/slant-recommend-28acad.svg["Slant", link="https://www.slant.co/topics/1323/~best-irc-clients-for-linux"] image:https://img.shields.io/badge/help-donate%20%E2%9D%A4-ff69b4.svg["Donate", link="https://weechat.org/donate/"]

image:https://github.com/weechat/weechat/workflows/CI/badge.svg["CI", link="https://github.com/weechat/weechat/actions"] image:https://codecov.io/gh/weechat/weechat/branch/master/graph/badge.svg["Code coverage", link="https://codecov.io/gh/weechat/weechat"]

WeeChat (Wee Enhanced Environment for Chat) is a free chat client, fast and light, designed for many operating systems. It is highly customizable and extensible with scripts.

Homepage: https://weechat.org/

== Features

pass:[

] image:https://weechat.org/media/images/screenshots/weechat/medium/weechat_2013-04-27_phlux_shadow.png[align="center"] pass:[

]

On WeeChat's website you can find https://weechat.org/about/screenshots/[more screenshots].

== Install

=== Dependencies

Following packages are required:

  • CMake
  • libncurses
  • libcurl
  • zlib
  • libgcrypt

Following packages are optional:

  • for i18n: gettext
  • for SSL: gnutls, ca-certificates
  • for spell checking: aspell or enchant
  • for scripting: python, perl, ruby, lua, tcl, guile, libv8 (javascript), php
  • for building doc and man page: asciidoctor
  • for building tests: C++ compiler, CppUTest

For a complete list of dependencies and versions recommended, please look at https://weechat.org/files/doc/devel/weechat_user.en.html#dependencies[user's guide].

=== Compile

WeeChat can be built with https://cmake.org/[CMake] (recommended) or autotools.

[NOTE] Only CMake is officially supported to build WeeChat. You should only use autotools if you are not able to use CMake. + Building with autotools requires more dependencies and is slower than with CMake.

  • Installation in system directories (requires root privileges):

$ mkdir build $ cd build $ cmake .. $ make $ sudo make install

  • Installation in custom directory (for example your home):

$ mkdir build $ cd build $ cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/directory $ make $ make install

For more information or installation with autotools, please look at https://weechat.org/files/doc/devel/weechat_user.en.html#compile_with_autotools[user's guide].

=== Run tests

Following packages are required to compile tests:

  • libcpputest-dev
  • C++ compiler

Tests must be enabled when compiling WeeChat:


$ cmake .. -DENABLE_TESTS=ON

They can be launched after compilation from the build directory:


$ ctest -V

== Copyright

Copyright (C) 2003-2021 Sébastien Helleu [email protected]

This file is part of WeeChat, the extensible chat client.

WeeChat is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

WeeChat is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with WeeChat. If not, see https://www.gnu.org/licenses/.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (69,965
python (53,699
php (16,544
c (15,324
ruby (12,870
lua (2,091
perl (1,380
client (394
chat (389
scheme (188
irc (112
scripting (97
tcl (79
extensible (24