diff options
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/README.adoc b/README.adoc index 86ff908..5181aa9 100644 --- a/README.adoc +++ b/README.adoc @@ -1,6 +1,6 @@ = Stundenplan -A small JavaScript project to generate beautiful PDF schedules. Takes information from `src/variables.js`. +A small JavaScript project to generate beautiful PDF schedules. Takes information from `public/config.yaml`. == Usage @@ -43,20 +43,26 @@ hinweise: eintraege: - <MODULE NAME>: <LECTURE TYPE>: - - [<GERMAN ABBREVIATION FOR THE WEEKDAY>, <START TIME>, <END TIME>, <ROOM>] + - [<WEEKDAY>, <START TIME>, <END TIME>, <ROOM>] ``` -Please note that times should be given in the format `HHhMM` so to say 9:19 AM, you would actually write 09h19. Also the Module and Lecture `BLOCKED` is reserved for a cross hatched block. +[NOTE] +.Please note the following exceptions: +==== +* `START TIME` and `END TIME` should be given in the format `HHhMM` so to say "1:02 PM", you would actually write `13h02`. +* `WEEKDAY` should be given in abbreviated form without a dot. I.e. "Wednesday" becomes `Mi`. +* The Module `STYLECLASS` is reserved for special stylized cases. -So writing +So for example writing ```yaml ... - - BLOCKED: + - STYLECLASS: BLOCKED: ... ``` -would put a blocked area in the pdf, instead of putting an actual block with the text "BLOCKED / BLOCKED". +would put a blocked area in the pdf, instead of putting an actual block with the text "STYLECLASS / BLOCKED". +==== == Known issues @@ -65,4 +71,4 @@ would put a blocked area in the pdf, instead of putting an actual block with the - Margin on the left not easily configurable - Mensa times are not actually displayed - All config.yaml items are required -- Code is german spaghetti
\ No newline at end of file +- Code is german spaghetti |