moparisthebest
/
hexchat
mirror of https://github.com/moparisthebest/hexchat
1
0
Fork 0
Code Issues Releases Wiki Activity

Update readme.md

This commit is contained in:
TingPing 2013-09-29 20:44:12 -04:00
parent 83fcb52085
commit 76b1c2f1ed
1 changed files with 5 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
readme.md
View File

@ -15,9 +15,11 @@ For building instructions, see [Building](http://docs.hexchat.org/en/latest/buil
## What is it? ## What is it?
HexChat is an IRC client for Windows and UNIX operating systems. I.R.C. is 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 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. in general. HexChat runs on most BSD and POSIX compliant operating systems.
For more information please read our documentation: http://hexchat.readthedocs.org.
## Requirements: ## Requirements:
@ -39,24 +41,18 @@ HexChat is known to work on, at least:
* OS X * OS X
## Notes for packagers:
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: ## Python Scripts:
Consider using the Python interface for your scripts, it's a very nice Consider using the Python interface for your scripts, it's a very nice
API, allows for loading/unloading individual scripts, and gives you API, allows for loading/unloading individual scripts, and gives you
almost all the features of the C plugin API. For more info, see the 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). [HexChat Python Interface](http://hexchat.readthedocs.org/en/latest/script_python.html).
## Perl Scripts: ## Perl Scripts:
Perl 5.8 or newer is required. For more info, see the Perl 5.8 or newer is required. For more info, see the
[HexChat Perl Interface](http://docs.hexchat.org/en/latest/script_perl.html). [HexChat Perl Interface](http://hexchat.readthedocs.org/en/latest/script_perl.html).
## Autoloading Scripts and Plugins: ## Autoloading Scripts and Plugins:
@ -72,18 +68,3 @@ Referred to as <config> from now. HexChat automatically loads, at startup:
* <config>/addons/*.py Python scripts * <config>/addons/*.py Python scripts
* <config>/addons/*.dll Plugins (Windows) * <config>/addons/*.dll Plugins (Windows)
* <config>/addons/*.so Plugins (Unix) * <config>/addons/*.so Plugins (Unix)
## Control Codes:
* %% - A single percentage sign
* %C - Control-C (mIRC color code)
* %B - Bold Text
* %U - Underline Text
* %R - Reverse Text
* %O - Reset all Text attributes
* %XXX - ASCII XXX (where XXX is a decimal 3 digit number, e.g.: %007 sends a BEEP)
%Cforeground,background will produce a color code, e.g.: %C03,10
These are now disabled by default (see _Settings_ `->` _Preferences_ `->` _Input Box_).
Instead you can insert the real codes via ctrl-k, ctrl-b and ctrl-o.