From 51ef51bbe3b741a76d1d44b8ce8c1d8a07427e1f Mon Sep 17 00:00:00 2001
From: Harald Eilertsen <haraldei@anduin.net>
Date: Tue, 10 Oct 2023 21:10:19 +0200
Subject: Updates for Ramaskrik 2023

- Reorg, create lib dir and move room-schedule and events there
- Add .ics template to generate program as an iCalendar stream.
- Add some info to html template, and instructions to html template.
- Add footer to html template, with timestamp for when the view was
  generated.
- Fix bug that messed up the layout if the input data was not already
  sorted.
- Update readme with usage instructions.
---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index ed25d3c..e618284 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,47 @@ Et lite script jeg laget for å gjøre det enklere for meg selv å få oversikt
 
 Siden som genereres av scriptet krever en nettleser med SVG 1.1 støtte, noe [de fleste](https://developer.mozilla.org/en-US/docs/Web/SVG/Element/foreignObject#Browser_compatibility) skulle ha i dag.
 
+## Bruksanvisning
+
+Programmet tar en `.json` fil med data som input. Dataene må være en json liste (array) hvor hvert object i listen er en visning. Hver visning må ha følgende felter:
+
+- title: tekst, Filmens tittel
+- venue: telst, Sal/auditorium/rom for visningen
+- start\_time: tid+dato i et noenlunde maskinlesbart standardformat (ISO8601 er fint!)
+- duration: Visningens lengde i sekunder
+- image: url til filmplakat (valgfritt)
+
+Her er et eksempel fra en fil:
+
+```json
+[
+    {
+        "title":"Satanic Hispanics",
+        "venue":"Storsalen",
+        "start_time":"2023-10-19 10:30:00 +0200",
+        "duration":"6300",
+        "image":"https://mff.dx.no/132216.jpeg?w=270&h=480&fit=crop&auto=compress"
+    },
+    {
+        ...
+    }
+]
+```
+
+Kjør programmet slik:
+
+```
+% ruby ramaskrik-program.rb <input-fil.json>
+```
+
+Den skal da generere en `index.html` og en `program.ics` (kalender) fil i samme katalog.
+
+Last opp disse til et egnet sted på en webserver, og du har ditt eget ramaskrik program.
+
+Programmet kan selvsagt brukes til å lage andre tilsvarende programoversikter også. Bare
+tilpass koden og malene etter ønske.
+
+
 ## LISENS
 
 Copyright (C) 2018  [Harald Eilertsen](haraldei@anduin.net)
-- 
cgit v1.2.3