diff --git a/README.md b/README.md index e69de29..cb8ff4d 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,18 @@ +## Ampel - Version 0.1 aka "better scm this shit" +This lovely piece of code is designed to display traffic lights indicating the presence or absence of anything. + +It is designed to run on any OS running python3 and a reasonable modern browser. Yes, even Windows is supported +but not yet tested (comming soon™). + +The main porpuse is intendet for 2-3 lights indicating the availability of employees. + +## Technical stuff +Ampel is build with python, flask, html5 with canvas, css3 and also some javascript. + +## Hack me +The code is quiet flat. Try to hack around with it to suit your needs. +All rendering is as generic as possible while fitting close to my needs. +But adding more lights is for example just a matter of adjusting the CSS and adding a new line to "bearbeiter.txt" - +thats all, everything else is already done. + +PRs are always welcome. Feature requests beeing noticed at least.