Initial commit

Only 2 blocks: time and weather.  Currently data is passed in formatted
strings made server-side (python) just for testing, later the formatting
should be client-side (html).

Also the "time" API might be redundant, ideally it should pass the city
names, and offsets (time zone), and then just use the system time
(otherwise DST jumps would need to be taken into account).

1 files changed, 36 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..71c0ae3
--- /dev/null
+++ b/README
@@ -0,0 +1,36 @@
+MASU - minimalist dashboard
+
+what: grid of blocks (clocks, weather, etc) w/ real-time updates
+
+how: flask + vanilla js, no bloat
+
+why: simple, tweakable, fast
+
+setup:
+
+    git clone <url>
+    python -m venv .venv
+    source .venv/bin/activate
+    pip install flask requests
+    flask run
+
+use:
+
+    http://localhost:5000
+    reload/tweak in header
+
+files:
+
+    app.py: server
+    static/: css, js
+    templates/: html
+
+hack:
+
+    add blocks: app.py + script.js
+    set intervals: script.js
+
+deploy:
+
+    local: python app.py
+    server: pip install gunicorn; gunicorn -w 4 app:app