1
0
mirror of https://github.com/weechat/weechat.git synced 2026-06-12 14:14:48 +02:00
Sébastien Helleu 4d0a9d5b4c core: remove sort on configuration files and sections
The sort was causing bugs because some options were missing while reading
other options, so the order of sections is important, they must not be
sorted.

This is a partial revert of commit 56f099bec6.
2014-09-29 20:35:25 +02:00
2014-09-21 20:52:12 +02:00
2007-07-02 12:25:13 +00:00
2014-08-15 10:09:01 +02:00

= WeeChat
:author: Sébastien Helleu
:email: flashcode@flashtux.org
:lang: en


WeeChat (Wee Enhanced Environment for Chat) is a fast and light chat
environment for many operating systems. Everything can be done with a keyboard.
It is customizable and extensible with scripts.

Homepage: http://weechat.org/

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

== Features

* Modular chat client with a lightweight core and optional plugins.
* Multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & other).
* Multi-protocols architecture (mainly IRC).
* Compliant with IRC RFCs 1459, 2810, 2811, 2812 and 2813.
* Small, fast and very light.
* Customizable and extensible with plugins (C, Perl, Python, Ruby, Lua, Tcl, Guile).
* Fully documented and translated into several languages.
* Developed from scratch.
* Free software, released under GPLv3.

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

== 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
* for scripting: python, perl, ruby, lua, tcl, guile
* for building doc: asciidoc, source-highlight
  (for man page: xsltproc, docbook-xml, docbook-xsl)
* for building tests: C++ compiler, CppUTest

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

=== Compile

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

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

----
$ mkdir build
$ cd build
$ cmake .. -DPREFIX=/path/to/directory
$ make
$ make install     (as root for installation in system directories)
----

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

== Copyright

Copyright (C) 2003-2014 Sébastien Helleu <flashcode@flashtux.org>

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 <http://www.gnu.org/licenses/>.
Languages
C 79.5%
C++ 17.8%
Python 1.6%
CMake 0.8%
Shell 0.2%
Other 0.1%