diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 10 |
1 files changed, 6 insertions, 4 deletions
| @@ -6,8 +6,8 @@ What is BEINC? | |||
| 6 | -------------- | 6 | -------------- |
| 7 | 7 | ||
| 8 | Blackmore's Enchanced IRC Notification Collection (BEINC) is a free set of | 8 | Blackmore's Enchanced IRC Notification Collection (BEINC) is a free set of |
| 9 | components that aim to provide a complete system for different on-screen-display | 9 | components that aims to provide a complete system for different |
| 10 | notification scenarios. | 10 | on-screen-display notification scenarios. |
| 11 | 11 | ||
| 12 | The current version of BEINC contains the following components: | 12 | The current version of BEINC contains the following components: |
| 13 | beinc_server.py - server used for queueing or providing on-screen-display (OSD) | 13 | beinc_server.py - server used for queueing or providing on-screen-display (OSD) |
| @@ -19,7 +19,7 @@ beinc_generic_client.py - a simple client used to push notification messages | |||
| 19 | to beinc_server.py | 19 | to beinc_server.py |
| 20 | Its main purpose is to provide a convenient way to | 20 | Its main purpose is to provide a convenient way to |
| 21 | test beinc_server.py (and beinc_poller.py) as well as | 21 | test beinc_server.py (and beinc_poller.py) as well as |
| 22 | to serve as an example on how to develop BEINC-clients | 22 | to serve as an example for how to develop BEINC-clients |
| 23 | + documentation and a sample configuration file (beinc_config_sample.json) | 23 | + documentation and a sample configuration file (beinc_config_sample.json) |
| 24 | 24 | ||
| 25 | 25 | ||
| @@ -93,7 +93,9 @@ All components tested on: Gentoo GNU/Linux 2014,2015, | |||
| 93 | 93 | ||
| 94 | 94 | ||
| 95 | Requirements: | 95 | Requirements: |
| 96 | All components: Python 2.7.* (for TLS1.1 and TLS1.2 client support you ned Python>=2.7.9) | 96 | All components: Python 2.7.* |
| 97 | N.B. For TLS1.1 and TLS1.2 client support you need Python>=2.7.9 | ||
| 98 | |||
| 97 | beinc_server.py: Twisted Web >= 14.0, pyopenssl >= 0.13.0, | 99 | beinc_server.py: Twisted Web >= 14.0, pyopenssl >= 0.13.0, |
| 98 | pynotify >= 0.1 (optional), pyosd >= 0.2 (optional) | 100 | pynotify >= 0.1 (optional), pyosd >= 0.2 (optional) |
| 99 | beinc_weechat.py: Weechat >= 0.4.0 | 101 | beinc_weechat.py: Weechat >= 0.4.0 |
