Add readme

RubenAstudillo · Oct 26, 2023 · 6ff3622 · 6ff3622
1 parent 47d7dec
commit 6ff3622
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+# RSI-break
+
+Quick pomodoro style timer so you hands get a rest interval.
+
+## Health advice
+
+This is a tool but not a cure. Physical therapy with an specialist can give
+you a window of time where you are free of pain. Then exercise is the long
+term solution. I am following this path, ask me in 3 years if it worked :-)
+.
+
+## This is GUI programming
+
+It should be pretty self explanatory on how to use. If you have `mpv`
+installed on your PATH you will also get a _ding_ sound when the timer goes
+off.
+
+![The program on all its glory](https://i.imgur.com/dfcJWBj.png)
diff --git a/rsi-break.cabal b/rsi-break.cabal
@@ -1,8 +1,7 @@
 cabal-version:      3.0
 name:               rsi-break
 version:            0.1.0.0
--- synopsis:
--- description:
+synopsis:           Let your mind know that your hands need a rest!
 license:            BSD-2-Clause
 license-file:       LICENSE
 author:             Ruben Astudillo