You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Sébastien Helleu 7b23f008a6 core: add contributor in AUTHORS.asciidoc 8 years ago
cmake core: fix Lua detection on Cygwin with cmake 8 years ago
debian core: sync debian files with debian git repository 8 years ago
doc relay: use comma separator in option relay.irc.backlog_tags, check the value of option when it is changed with /set 8 years ago
po relay: use comma separator in option relay.irc.backlog_tags, check the value of option when it is changed with /set 8 years ago
scripts Revert "core: use argument "-i" for sed command (don't create a temporary file)" 8 years ago
src irc: add tag "nick_xxx" in invite messages 8 years ago
tests Merge branch 'arraylist' 8 years ago
.gitattributes core: add file weechat.cygport.in in tarballs (fix compilation error when compiling tarball) 9 years ago
.gitignore core: add file "compile" in .gitignore 9 years ago
.travis.yml core: add empty line in .travis.yml 8 years ago
AUTHORS.asciidoc core: add contributor in AUTHORS.asciidoc 8 years ago
CMakeLists.txt core: install extra files for Cygwin in share/doc/weechat 8 years ago
COPYING Replaced GPL 2 license by GPL 3 15 years ago
ChangeLog.asciidoc core: update ChangeLog 8 years ago
Contributing.asciidoc core: add note about security issues and translations in Contributing.asciidoc 8 years ago
Makefile.am tests: add compilation of tests with autotools 8 years ago
README.asciidoc core: add C++ compiler and CppUTest for tests in README 8 years ago
ReleaseNotes.asciidoc relay: use comma separator in option relay.irc.backlog_tags, check the value of option when it is changed with /set 8 years ago
autogen.sh core: fix build with autotools and gettext >= 0.19 8 years ago
config.h.cmake guile: fix compilation with Guile < 2.0.4 (closes #198) 8 years ago
configure.ac core: add detection of Lua 5.2 with autotools 8 years ago
makedist.sh core: build packages in build directory on "make dist" (CMake) 8 years ago
weechat.cygport.in core: add pkg-config dependency for Cygwin packaging 8 years ago
weechat.pc.in Install developement files for plugins and pkg-config support (cmake). 13 years ago
weechat.png core: update WeeChat logo (32x32 icon) 9 years ago
weechat.spec Version 1.0 8 years ago

README.asciidoc

= 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/>.