docs/readme.mdwn
author Myhailo Danylenko <isbear@ukrpost.net>
Fri, 17 Aug 2012 19:09:41 +0300
changeset 30 3a18a8bf797b
parent 29 5d86c5fefef6
child 31 d7b9a5a84f96
permissions -rw-r--r--
Fix readme


# Welcome to Yet Another Yuseless Built-In Language!

This module provides next commands:

 * 'multi' allows to execute several mcabber commands at once.
   Handy for bindings, aliases, hooks and other. Use semicolons
   to separate commands (note, however, that commands itself cannot
   contain semicolon).
 * 'if', 'then' and 'else' provide crude conditional construction.
   'if' evaluates given expression (see 'eval' for rules) and stores
   result. After that, 'then' and 'else' can be executed as many times,
   as you need, they will use stored value.
 * 'let' works like 'set', but assigned value is evaluated first
   (see 'eval' for rules).
 * 'eval' evaluates expression and then executes it as mcabber command.
   Expression can contain unquoted variable names, double-quoted strings,
   numbers and next operators:

    * . string concatenation
    * : string head
    * \^ string tail
    * \+ binary plus / string concatenation
    * \- binary minus
    * \* multiplication / string replication
    * / division
    * % division remain
    * \< binary / string less than
    * \> binary / string greater than
    * = binary / string equality

   All operators have the same priority, and there is no grouping.

All commands are marked as safe to use in initial config file.

# Installation

To install it, you need:

 * cmake
 * make
 * gcc
 * glib
 * mcabber headers

Then do

    $ mkdir build
    $ cd build
    $ cmake ..
    $ make edit_cache
    $ make
    # make install

Debian users can instead of make install do

    $ make package
    # dpkg -i libmcabber-yaubil*.deb

Users of other distributions can select appropriate package
generator, using cache editor.

# License

This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING
from this distribution or on a GNU web-site <http://www.gnu.org/licenses/>.

# Contact

I will be happy to get feedback, patches, suggestions, etc.
You can send me email or contact via jabber <isbear@unixzone.org.ua>.

  -- Myhailo Danylenko <isbear@ukrpost.net>