Profanity filter, please.
[kiosk.git] / README.txt
1 Root directory of the kitchen kiosk project.  It works like this:
2
3 kiosk.py is the main entry point.  It has two jobs: start up a chooser
4 thread that picks what the kiosk is currently showing by moving a
5 symlink called current.html in the ./pages/ directory.  It has a kinda
6 crazy semantic for doing this:
7
8   1. it looks for all files that look like [name]_[weight]_[staleness].html
9   2. it sees if there are any trigger conditions (e.g. movement on a webcam)
10      and, if so, it choose the appropriate page (./pages/hidden/*)
11   3. otherwise it does a weighted random selection based on [weight], as
12      long as [staleness] is not too stale.
13
14 The other main thread in kiosk is a renderer thread which knows how to go
15 out and fetch information from the web somewhere and make a page with a
16 filename of something like [basename]_[weight]_[staleness].html.  It makes
17 a bunch of these off in ./pages and refreshes them at periodic intervals.
18 All of this code is in renderer.py and it's kinda ugly.
19
20 Feel free to mail me if you have questions: [email protected].