summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--AUTHORS.asciidoc4
-rw-r--r--INSTALL.asciidoc45
-rw-r--r--Makefile.am1
-rw-r--r--README.asciidoc67
-rw-r--r--weechat.spec2
5 files changed, 62 insertions, 57 deletions
diff --git a/AUTHORS.asciidoc b/AUTHORS.asciidoc
index 51141c39b..1cce2f5bd 100644
--- a/AUTHORS.asciidoc
+++ b/AUTHORS.asciidoc
@@ -1,5 +1,7 @@
= WeeChat Authors
-Sébastien Helleu <flashcode@flashtux.org>
+:author: Sébastien Helleu
+:email: flashcode@flashtux.org
+:lang: en
== Developers
diff --git a/INSTALL.asciidoc b/INSTALL.asciidoc
deleted file mode 100644
index 646b9b83c..000000000
--- a/INSTALL.asciidoc
+++ /dev/null
@@ -1,45 +0,0 @@
-= WeeChat Installation instructions
-Sébastien Helleu <flashcode@flashtux.org>
-
-
-WeeChat can be built with 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.
-
-== Dependencies
-
-Following packages are *required*:
-
-* cmake
-* libncurses
-* libcurl
-* zlib
-* libgcrypt
-
-Following packages are all 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 a complete list of dependencies and versions recommended, please look at
-'User's guide'.
-
-== Installation 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
-'User's guide': http://weechat.org/doc
diff --git a/Makefile.am b/Makefile.am
index a01f46f25..ac74f3960 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -29,7 +29,6 @@ SUBDIRS = po doc intl src
EXTRA_DIST = AUTHORS.asciidoc \
ChangeLog.asciidoc \
- INSTALL.asciidoc \
README.asciidoc \
ReleaseNotes.asciidoc \
CMakeLists.txt \
diff --git a/README.asciidoc b/README.asciidoc
index 36b6985dc..d5836e824 100644
--- a/README.asciidoc
+++ b/README.asciidoc
@@ -1,21 +1,70 @@
-= WeeChat Readme
-Sébastien Helleu <flashcode@flashtux.org>
+= WeeChat
+:author: Sébastien Helleu
+:email: flashcode@flashtux.org
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/
+
== Features
-* chat client with multi-protocols/servers connection
-* small, fast and very light
-* customizable and extensible with plugins (C, Perl, Python, Ruby, Lua, Tcl, Guile)
-* compliant with IRC RFCs 1459, 2810, 2811, 2812 and 2813
-* developed from scratch
-* multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & other)
-* free software, released under GPLv3
+* 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.
+
+== 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 a complete list of dependencies and versions recommended, please look at
+http://weechat.org/doc[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/doc[user's guide].
== Copyright
diff --git a/weechat.spec b/weechat.spec
index 08cbe9854..f436ec5d9 100644
--- a/weechat.spec
+++ b/weechat.spec
@@ -65,7 +65,7 @@ rm -rf $RPM_BUILD_ROOT
%files -f %{name}.lang
%defattr(-,root,root,0755)
-%doc AUTHORS.asciidoc ChangeLog.asciidoc COPYING INSTALL.asciidoc README.asciidoc ReleaseNotes.asciidoc
+%doc AUTHORS.asciidoc ChangeLog.asciidoc COPYING README.asciidoc ReleaseNotes.asciidoc
%doc %{_docdir}/%{name}/*.html
%{_mandir}/man1/%{name}.1*
%{_mandir}/*/man1/%{name}.1*