summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 26 insertions, 16 deletions
diff --git a/README.md b/README.md
index 388562b..200e29d 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
1Copyright (C) 2014-2018 - Simeon Simeonov 1Copyright (C) 2014-2020 - Simeon Simeonov
2See the end of the file for license conditions. 2See the end of the file for license conditions.
3 3
4 4
@@ -10,14 +10,14 @@ on-screen-display notification scenarios.
10 10
11The current version of BEINC contains the following components: 11The current version of BEINC contains the following components:
12beinc_server.py - server used for queueing or providing on-screen-display (OSD) 12beinc_server.py - server used for queueing or providing on-screen-display (OSD)
13beinc_poller.py - client used to fetch enqueued messages from beinc_server.py 13beinc_pull.py - client used to fetch enqueued messages from beinc_server.py
14 and provide OSD 14 and provide OSD
15beinc_weechat.py - a complete script / client for the Weechat IRC client >=0.4.0 15beinc_weechat.py - a complete script / client for the Weechat IRC client >=0.4.0
16 used to push notification messages to beinc_server.py 16 used to push notification messages to beinc_server.py
17beinc_generic_client.py - a simple client used to push notification messages 17beinc_generic_client.py - a simple client used to push notification messages
18 to beinc_server.py 18 to beinc_server.py
19 Its main purpose is to provide a convenient way to 19 Its main purpose is to provide a convenient way to
20 test beinc_server.py (and beinc_poller.py) as well as 20 test beinc_server.py (and beinc_pull.py) as well as
21 to serve as an example for how to develop BEINC-clients 21 to serve as an example for how to develop BEINC-clients
22+ documentation and a sample configuration file (beinc_config_sample.json) 22+ documentation and a sample configuration file (beinc_config_sample.json)
23 23
@@ -28,7 +28,7 @@ BEINC is a free-software, licensed under the GPL3. It gives you the freedoms
28of using it, studying it and modifying it. 28of using it, studying it and modifying it.
29 29
30BEINC is designed to assist you two common scenarios. 30BEINC is designed to assist you two common scenarios.
31As an example we will consider the case of an IRC cliet, although BEINC can be 31As an example we will consider the case of an IRC client, although BEINC can be
32used by any client that conforms with BEINC's "messaging protocol". 32used by any client that conforms with BEINC's "messaging protocol".
33 33
34We have the common situation where a user is accessing an IRC client located on 34We have the common situation where a user is accessing an IRC client located on
@@ -66,20 +66,20 @@ Solution:
66 - set up the beinc_server.py on it. No OSD capabilities are needed (no X11). 66 - set up the beinc_server.py on it. No OSD capabilities are needed (no X11).
67 Define instance(s) for queueing. Define a queue size 67 Define instance(s) for queueing. Define a queue size
68 (how many notifications to store) for each of them. 68 (how many notifications to store) for each of them.
69 - set up beinc_poller.py on the desktop workstation (the computer where the 69 - set up beinc_pull.py on the desktop workstation (the computer where the
70 notification-message should be displayed). 70 notification-message should be displayed).
71 beinc_poller.py should be able to access the server running beinc_server.py 71 beinc_pull.py should be able to access the server running beinc_server.py
72 Polling interval of 5 seconds should be enough for most users. 72 Pulling interval of 5 seconds should be enough for most users.
73 73
74Read beinc_config_sample.json.readme for details on how to setup 74Read beinc_config_sample.json.readme for details on how to setup
75beinc_server.py and beinc_weechat.py! 75beinc_server.py and beinc_weechat.py!
76Use "-h" command line parameter to display the available options for 76Use "-h" command line parameter to display the available options for
77beinc_poller.py and beinc_generic_client.py 77beinc_pull.py and beinc_generic_client.py
78Each configured beinc_server.py instance has an unique name. 78Each configured beinc_server.py instance has an unique name.
79There are 2 operations that can be done on an instance: 79There are 2 operations that can be done on an instance:
80 - push - a client is sending a notification to the BEINC server. 80 - push - a client is sending a notification to the BEINC server.
81 A push is available for all instances. 81 A push is available for all instances.
82 - pull - a poller (f.i. beinc_poller.py) is fetching data from the instance-queue. 82 - pull - a pull (f.i. beinc_pull.py) is fetching data from the instance-queue.
83 A pull is available only for instances defined for queueing. 83 A pull is available only for instances defined for queueing.
84 (read beinc_config_sample.json.readme for details!) 84 (read beinc_config_sample.json.readme for details!)
85Example: 85Example:
@@ -91,28 +91,38 @@ your URL will be: https://hostname:port
91 91
92Any system running the software required for the selected components. 92Any system running the software required for the selected components.
93All components tested on: Gentoo GNU/Linux, 93All components tested on: Gentoo GNU/Linux,
94 Ubuntu GNU/Linux 16.4, 18.4, 94 Ubuntu GNU/Linux 18.4,
95 FreeBSD 10.x, 11.x 95 FreeBSD 12.x
96 96
97 97
98### Requirements 98### Requirements
99All components: Python >= 2.7.9 or Python >= 3.4.* 99All components: Python >= 3.6.*
100 100
101beinc_server.py: pynotify >= 0.1 (optional) 101beinc_server.py: pynotify >= 0.1 (optional)
102beinc_weechat.py: Weechat >= 0.4.0 102beinc_weechat.py: Weechat >= 0.4.0
103beinc_poller.py: pynotify >= 0.1 103beinc_pull.py: pynotify >= 0.1
104beinc_generic_client.py: No additional software required 104beinc_generic_client.py: No additional software required
105 105
106Read INSTALL in this very same folder for more details about installing the requirements! 106Read INSTALL in this very same folder for more details about installing the requirements!
107 107
108 108
109### License 109## Support and contributing
110
111BEINC is hosted on GitHub: https://github.com/blackm0re/BEINC
112
113
114## Author
115
116Simeon Simeonov - sgs @ Freenode
117
118
119## License
110 120
111This file is part of BEINC. 121This file is part of BEINC.
112 122
113BEINC is free software: you can redistribute it and/or modify 123BEINC is free software: you can redistribute it and/or modify
114it under the terms of the GNU General Public License as published by 124it under the terms of the GNU General Public License as published by
115the Free Software Foundation, either version 3 of the License, or 125the Free Software Foundation, either version 3 of the License, or
116(at your option) any later version. 126(at your option) any later version.
117 127
118This program is distributed in the hope that it will be useful, 128This program is distributed in the hope that it will be useful,