README.adoc 4.5 KB
Newer Older
1 2 3
= WeeChat
:author: Sébastien Helleu
:email: flashcode@flashtux.org
4
:lang: en
Sebastien Helleu's avatar
Sebastien Helleu committed
5

6

7 8
image:https://img.shields.io/badge/diaspora*-follow-blue.svg["Diaspora*", link="https://diasp.eu/u/weechat"]
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/paypal-donate%20%E2%9D%A4-yellow.svg["Paypal", link="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4LSMSNLUAJWNS"]
12

13 14
image:https://travis-ci.org/weechat/weechat.svg?branch=master["Build Status", link="https://travis-ci.org/weechat/weechat"]

15 16 17
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.
Sebastien Helleu's avatar
Sebastien Helleu committed
18

19
Homepage: https://weechat.org/
20

21
== Features
22

neutric's avatar
neutric committed
23
* *Modular chat client*: WeeChat has a lightweight core and optional plugins. All plugins (including IRC) are independent and can be unloaded.
24 25 26 27
* *Multi-platform*: WeeChat runs on GNU/Linux, *BSD, GNU/Hurd, Mac OS X and Windows (Bash/Ubuntu and Cygwin).
* *Multi-protocols*: WeeChat is designed to support multiple protocols by plugins, like IRC.
* *Standards-compliant*: the IRC plugin is compliant with RFCs 1459, 2810, 2811, 2812 and 2813.
* *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).
neutric's avatar
neutric committed
29
* *Fully documented*: there is comprehensive documentation, which is translated into several languages.
30 31
* *Developed from scratch*: WeeChat was built from scratch and is not based on any other client.
* *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 36
Other screenshots are on https://weechat.org/about/screenshots/[this page].

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
== 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
Sébastien Helleu's avatar
Sébastien Helleu committed
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 62 63 64 65

=== Compile

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

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

70
* Installation in system directories (requires _root_ privileges):
71 72 73 74 75 76

----
$ mkdir build
$ cd build
$ cmake ..
$ make
77
$ sudo make install
78 79
----

80
* Installation in custom directory (for example your home):
81

82 83 84
----
$ mkdir build
$ 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 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
=== 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
----

112
== Copyright
113

114
Copyright (C) 2003-2017 Sébastien Helleu <flashcode@flashtux.org>
Sebastien Helleu's avatar
Sebastien Helleu committed
115

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

WeeChat is free software; you can redistribute it and/or modify
Sebastien Helleu's avatar
Sebastien Helleu committed
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
Sebastien Helleu's avatar
Sebastien Helleu committed
121 122
(at your option) any later version.

123
WeeChat is distributed in the hope that it will be useful,
Sebastien Helleu's avatar
Sebastien Helleu committed
124 125 126 127 128
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
129
along with WeeChat.  If not, see <http://www.gnu.org/licenses/>.