=================================================================================================
README / LuaNotify is a Lua package providing tools for implementing observer programming pattern
=================================================================================================

Introduction
------------
LuaNotify is inspired on many libraries that do event dispatching, like
py-notify, GSignals, QT event system, wxWidgets event system, etc. 

Quick start
-----------
Just copy the notify directory to a place where Lua can find it.  


Documentation
-----------
The documentation is generated using ldoc and lua-discount.
You can install them using luarocks:

luarocks install ldoc lua-discount

Inside the doc directory, just run:

ldoc.lua .

And the documentation will be generated.


Running tests
----------
To run the tests you will need lunit installed, just run:

luarocks install lunit



References
----------

Project website:
- http://wiki.github.com/katcipis/luanotify 

Version control repositories:
- git://github.com/katcipis/luanotify.git

Mailing list:
- luanotify-devel@lists.sourceforge.net
- https://lists.sourceforge.net/lists/listinfo/luanotify-devel

Licensing
---------

LuaNotify is licensed under terms of the GNU LGPL.
See the file "COPYING" for more information.