summaryrefslogtreecommitdiff
path: root/README
blob: 026c70dd6062f57d56b528973d04284ff86ebd51 (plain)
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
56
57
58
59
60
61
62
Copyright (C) 2014 - Simeon Simeonov
See the end of the file for license conditions.

The file INSTALL in this very same directory describes how to setup & use BEINC


What is BEINC?
--------------

Blackmore's Enchanced IRC Notification Collection (BEINC) is a free set of
components that aim to provide a complete system for different on-screen-display
notification scenarios.

The current version of BEINC contains the following components:
beinc_server.py - server used for queueing or providing on-screen-display (OSD)
beinc_poller.py - client used to fetch enqueued messages from beinc_server.py
                  and provide OSD
beinc_weechat.py - a complete script / client for the Weechat IRC client >=0.4.0
                   used to push notification messages to beinc_server.py
beinc_generic_client.py - a simple client used to push notification messages
                          to beinc_server.py
                          Its main purpose is to provide a convenient way to 
                          test beinc_server.py (and beinc_poller.py) as well as
                          to serve as an example on how to develop BEINC-clients


Why should I use BEINC and what has it done for me lately?
----------------------------------------------------------





Supported systems & requirements
--------------------------------
Any system running Postfix and Spamassassin.


Requirements:
All components: Python 2.7.*
beinc_server.py: cherrypy >= 3.2.0, pyopenssl >= 0.13.0
beinc_weechat.py:
beinc_poller.py: 


License
-------

This file is part of BEINC.

BEINC is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or                                                                                          
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>