summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 21 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9b682c8..5c2a195 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,22 @@
# bomSynoptic
-Automoated download and display of synoptic weather charts from the Australian Bureau of Meteorology
+Automated download and display of synoptic weather charts from the Australian Bureau of Meteorology
+
+## Background
+(explain motivation and desired results)
+
+## Current state
+Script can download most recent pdf and convert it to a scaled png file
+
+## todo
+
+ * write a timer service
+ * 'xdg-open' the png file in its own workspace (in i3 window manager)
+
+
+Files:
+
+File | Description | Location
+-----|-------------|---------
+synopticChart.sh | Top level script |
+func/deriveTimeString.sh | Return 'date + time' portion of latest chart for download
+func/