summaryrefslogtreecommitdiff
path: root/pomodoroarc-widget/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'pomodoroarc-widget/README.md')
-rw-r--r--pomodoroarc-widget/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/pomodoroarc-widget/README.md b/pomodoroarc-widget/README.md
new file mode 100644
index 0000000..49b1b2c
--- /dev/null
+++ b/pomodoroarc-widget/README.md
@@ -0,0 +1,16 @@
+# Pomodoro Widget
+
+:construction: This widget is under construction :construction_worker:
+
+## Installation
+
+This widget is based on [@jsspencer](https://github.com/jsspencer)' [pomo](https://github.com/jsspencer/pomo) - a simple pomodoro timer.
+So first install/clone it anywhere you like, then either
+ - in widget's code provide path to the pomo.sh, or
+ - add pomo.sh to the PATH, or
+ - make a soft link in /usr/local/bin/ to it:
+ ```bash
+ sudo ln -sf /opt/pomodoro/pomo.sh /usr/local/bin/pomo
+ ```
+
+Note that by default widget's code expects third way and calls script by `pomo`. \ No newline at end of file