iiiypuk/hexchat
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

readme cleanup

Browse Source
This commit is contained in:
Berke Viktor 2013-04-09 03:06:07 +02:00
parent b90633d406
commit 77fa72924b
1 changed files with 7 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
share/doc/readme.md
View File

@ -1,7 +1,7 @@
# HexChat ReadMe
X-Chat ("xchat") Copyright (c) 1998-2010 By Peter Zelezny.
HexChat ("hexchat") Copyright (c) 2009-2012 By Berke Viktor.
HexChat ("hexchat") Copyright (c) 2009-2013 By Berke Viktor.
This program is released under the GPL v2 with the additional exemption
that compiling, linking, and/or using OpenSSL is allowed. You may
@ -11,12 +11,14 @@ See file COPYING for details.
For building instructions, see [Building](http://docs.hexchat.org/en/latest/building.html).
## What is it?
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 more information about IRC
in general. HexChat runs on most BSD and POSIX compliant operating systems.
## Requirements:
* GTK+ 2.14
@ -24,7 +26,7 @@ in general. HexChat runs on most BSD and POSIX compliant operating systems.
HexChat is known to work on, at least:
* Windows XP/Vista/7/8
* Windows Vista/7/8
* Linux
* FreeBSD
* OpenBSD
@ -42,40 +44,20 @@ HexChat is known to work on, at least:
If you need your packages to work on i386, you don't need to compile with
--disable-mmx, because it's also checked at run-time.
## Python Scripts:
Scripts for XChat 1.8.x are not compatible, a brand new interface has been written. For more info, see the [HexChat Python Interface](http://docs.hexchat.org/en/latest/script_python.html).
## 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://docs.hexchat.org/en/latest/script_python.html).
## Perl Scripts:
Perl 5.8 or newer is required. For more info, see the [HexChat Perl Interface](http://docs.hexchat.org/en/latest/script_perl.html).
Scripts for XChat 1.8.x are compatible with the following exceptions:
* IRC::command will not interpret %C, %B, %U etc.
* user_list and user_list_short:
If a user has both op and voice, only the op flag will be 1.
* add_user_list/sub_user_list/clear_user_list
These functions do nothing.
* notify_list
Not implemented. Always returns an empty list.
* server_list
Lists servers that are not connected aswell.
* Some print events may have new names and some were added.
* Text printed by scripts must now be UTF8.
* Text passed to scripts (via add_message_handler) will be encoded in UTF8.
## Autoloading Scripts and Plugins:
@ -86,10 +68,8 @@ The root of your HexChat config is:
Referred to as <config> from now. HexChat automatically loads, at startup:
* <config>/addons/*.lua Lua scripts
* <config>/addons/*.pl Perl scripts
* <config>/addons/*.py Python scripts
* <config>/addons/*.tcl Tcl scripts
* <config>/addons/*.dll Plugins (Windows)
* <config>/addons/*.so Plugins (Unix)