-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathREADME
55 lines (35 loc) · 1.34 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
=================================================================================================
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:
- 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.