summary refs log tree commit diff stats
diff options
context:
space:
mode:
-rw-r--r--readme.md78
1 files changed, 24 insertions, 54 deletions
diff --git a/readme.md b/readme.md
index 3b42852e..4f4a8d64 100644
--- a/readme.md
+++ b/readme.md
@@ -1,6 +1,6 @@
-# HexChat ReadMe
+# HexChat [![Build Status](https://travis-ci.org/hexchat/hexchat.png)](https://travis-ci.org/hexchat/hexchat)
 
-X-Chat ("xchat") Copyright (c) 1998-2010 By Peter Zelezny.
+X-Chat ("xchat") Copyright (c) 1998-2010 By Peter Zelezny.  
 HexChat ("hexchat") Copyright (c) 2009-2013 By Berke Viktor.
 
 This program is released under the GPL v2 with the additional exemption
@@ -9,62 +9,32 @@ provide binary packages linked to the OpenSSL libraries, provided that
 all other requirements of the GPL are met.
 See file COPYING for details.
 
-For building instructions, see [Building](http://docs.hexchat.org/en/latest/building.html).
+## Information
 
+HexChat is an IRC client for Windows and UNIX-like operating systems.
+See [IRCHelp.org](http://irchelp.org) for information about IRC in general.
 
-## What is it?
+For more information please read our [documentation](https://hexchat.readthedocs.org/en/latest/index.html):
+- [FAQ](https://hexchat.readthedocs.org/en/latest/faq.html)
+- [Changelog](https://hexchat.readthedocs.org/en/latest/changelog.html)
+- [Python API](https://hexchat.readthedocs.org/en/latest/script_python.html)
+- [Perl API](https://hexchat.readthedocs.org/en/latest/script_perl.html)
 
-HexChat is an IRC client for Windows and UNIX operating systems. I.R.C. is
-Internet Relay Chat, see [IRCHelp.org](http://irchelp.org) for information about IRC
-in general. HexChat runs on most BSD and POSIX compliant operating systems.
+## Requirements
 
-For more information please read our documentation: http://hexchat.readthedocs.org.
-
-
-## Requirements:
-
- * GTK+ 2.24
- * GLib 2.28
+- GTK+ 2.24
+- GLib 2.28
 
 HexChat is known to work on, at least:
 
- * Windows Vista/7/8
- * Linux
- * FreeBSD
- * OpenBSD
- * NetBSD
- * Solaris
- * AIX
- * IRIX
- * DEC/Compaq Tru64 UNIX
- * HP-UX 10.20 and 11
- * OS X
-
-
-## Python Scripts:
-
-Consider using the Python interface for your scripts, it's a very nice
-API, allows for loading/unloading individual scripts, and gives you
-almost all the features of the C plugin API. For more info, see the
-[HexChat Python Interface](http://hexchat.readthedocs.org/en/latest/script_python.html).
-
-
-## Perl Scripts:
-
-Perl 5.8 or newer is required. For more info, see the
-[HexChat Perl Interface](http://hexchat.readthedocs.org/en/latest/script_perl.html).
-
-
-## Autoloading Scripts and Plugins:
-
-The root of your HexChat config is:
-
- * Windows: %APPDATA%\HexChat
- * Unix: ~/.config/hexchat
-
-Referred to as <config> from now. HexChat automatically loads, at startup:
-
- * <config>/addons/*.pl Perl scripts
- * <config>/addons/*.py Python scripts
- * <config>/addons/*.dll Plugins (Windows)
- * <config>/addons/*.so Plugins (Unix)
+- Windows Vista/7/8
+- Linux
+- FreeBSD
+- OpenBSD
+- NetBSD
+- Solaris
+- AIX
+- IRIX
+- DEC/Compaq Tru64 UNIX
+- HP-UX 10.20 and 11
+- OS X