aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ba8fe8a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+= Alonzo Mood Calculator
+
+Calculate Alonzo's likely mood for the day.
+
+== Installation
+
+Setup instructions (Debian):
+
+ # install yfinance
+ sudo pip3 install yfinance
+
+ # run bin/get-stock.py once to get the current prices
+ bin/get-stock.py ORCL > public/current.json
+
+ # set up cron job that calls bin/get-stock.py daily
+ # example:
+ @daily bin/get-stock.py ORCL > public/current.json
+
+ # symlink apache or whatever to public/ directory