initial edit of README.md

README.md

@@ -1,3 +1,79 @@
 # green-signals
 
-Source Repository for "Grüne Signale"
+## Introduction
+
+green-signals is the source code for "Grüne Signale" digital signage solution.
+
+## Features
+
+"Grüne Signale" offers a digital signage platform intended for use in showrooms.
+Main goal is to run a slideshow presenting end-user customizable contents with low efforts and budget required to set it up.
+
+* Low Budget solution
+* Low Knowledge requirements
+* All based on OpenSource modules and OpenSource itself
+* Playback of Images and Videos (muted)
+* Media files can be delivered in nested folders
+* Playback of Media follows alpabetical order
+* Easy to configure
+* Easy content updates via media download (zipped)
+* Once set up it shall run unattended
+* Written in Python 3
+
+## Prerequisites
+
+* Raspberry Pi computer with Power supply, HDMI cable and SD-Card
+* Display with HDMI input (best with HDMI CEC support)
+** this can be a dedicated computer monitor or a TV Set
+** the Display should support FullHD Resolution (native 1920x1080)
+* LAN or WLAN connection
+* Mouse and Keyboard only needed for initial setup
+* VLC Application (included in Full Raspian Image)
+* Python-VLC module (needs to be installed during setup)
+* Cloud account for automated media update (we suggest to use "Grüne Wolke")
+** The media files need to be provided as ZIP-File containing the images and videos
+
+## Media formats
+
+* Images in JPG or PNG format, same display duration for all images as configured
+* Videos in MOV, M4V or MP4 format
+* All media shall have 16:9 landscape format
+* All media will be scaled to fill the screen
+* Best resolution is 1920x1080 pixels (FullHD)
+* Video clips are muted during playback
+* Video clips should start and end with blending from/to a black frame (playback could flicker)
+
+## Environmental Topics
+
+* A Raspberry Pi computer has low energy consumption (usually less than 10W)
+* It can be configured for a safe shut down at night time (reduce light pollution)
+* A diplay supporting HDMI CEC will automatically switch to StandBy
+* Power for Raspberry Pi and display shall be turned off by a timer device
+** set the timer a few minutes after scheduled shut down of the Raspberry Pi computer
+** when the power is switched back on in the morning, The slideshow will autoomatically start and in background update the media files
+
+## Development Environment
+
+* The project is developed on a Raspberry Pi 400, any Raspberry Pi model (except Pico) is fine
+* The project is intended to run on Raspbian Linux
+** support for other platforms is possible, but not tested
+
+## TODOs
+
+* setup script
+** run p3 install python-vlc
+** add the script to auto-start
+** run configuration script
+* configuration script
+** add cronjob for safe shutdown at given time
+** add remote URL to config file, validating, that the URL points to a ZIP file.
+* improve initial startup
+** so far only dummy images for intial slideshow
+** provide manual in media slides and as documentation (Wiki?)
+** tutorials and other on-boarding guides (maybe with "Grünstreifen")
+* testing, testing
+** and more testing in real world ;-)
+
+## Contact:
+Chatbegruenung, Channel netzbegruenung-digitalsignage
+Stefan Schmidt-Bilkenroth, ssb@mac.com