diff --git a/README.md b/README.md index e9e1490dd522baf7ff1778a998f24e8f49c9cce1..c3c9bf3ce9c94d3bb8d2beaf0e9a7b01eae79880 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,44 @@ Schildergenerator ================= -A web page to quickly create and print signs using a common design. +A web service to quickly create and print signs using a common design. Especially useful for events. +You might find it useful in the following scenarios: + + * You need to set up an event where visitors need signs to point them around. + * You often need to change some signs in your organization. + * You're bored in the Fachschaftsbüro. + +What you need: + + * A printer on premise. + * Some kind of server, preferrably running a flavor of Linux, capable of printing + on said printer via lpd. A RaspberryPi would suffice, even if it's slow. + * Web clients of any type being able to connect to said server. + * The knowledge to modify a LaTeX template to fit your organizations design. + +After you put in the initial work of setting this up, you'll have a service +where everyone on your team can quickly create a new sign as soon as they see a +need for it (provided they've got a mobile web client) just by typing a headline +and some text, selecting or uploading an image -- and by the time they arrive at +the printer, the sign is already printed and ready to be posted on the wall. All +while heeding the event's design. + +> This script frees the event organisators of the responsibility to pre-think +> all the details of sign-making. Instead, this part can simply be delegated to +> the helpers who are setting up the event by showing them the web frontend of +> this tool. + + Dependencies ------------ - * python-flask python-genshi - * python-pythonmagick + graphicsmagick - * pdflatex latex-beamer - * libapache2-mod-wsgi for production use (or [anything capable of running WSGI apps](http://wsgi.readthedocs.org/en/latest/servers.html) really…) + * python-flask, python-genshi + * python-pythonmagick, graphicsmagick + * pdflatex, latex-beamer + * libapache2-mod-wsgi for production use + (or [anything capable of running WSGI apps](http://wsgi.readthedocs.org/en/latest/servers.html) really…) Download