diff --git a/README.md b/README.md index 2f840b8..3268dfd 100644 --- a/README.md +++ b/README.md @@ -9,17 +9,30 @@ * Time-oriented since I want to be able to pick the end time rather than a duration. * Some kind of obvious indication when time is up. -A quick survey of the app store showed that most apps in this category were: -* Butt fugly. -* Ridden with ads. -* Built for some specific purpose with mandatory breaks in the middle (WTH is pomodoro?). -* Most were not time-oriented. +A quick survey of the app store showed that most apps in this category: +* Were butt fugly. +* Were ridden with ads. +* Wanted more permissions than I was willing to give a timer app. +* Were built for some specific purpose with mandatory breaks in the middle (WTH is pomodoro?). +* Were in many cases not time-oriented. -So, figuring that it has been a while since I tortured myself by writing an Android app, I built one that does what I need. FYI - Android development still sucks. Glad to see things have not changed since I last had to build an app a few years back. +So, figuring that it has been a while since I tortured myself by writing an Android app, I built one that does what I need. + +# Downloading + +The APK is in the `app/build/outputs/apk/release` folder. Download and side load it. + +# Requirements + +Requires Android version 26 (Oreo) or better. # Usage -Run the app. Enter your end time. If you bugger it up, tap reset. Set the display update rate (defaults to 5 seconds). Set the dim screen option if you want it (should use less battery with the screen dimmed). Tap start. +1. Run the app. +2. Enter your end time. If you bugger it up, tap reset. +3. Set the display update rate (defaults to 5 seconds). +4. Set the dim screen option (should use less battery with the screen dimmed). +5. Tap start. -It will count down the minutes until the end time. At 2 minutes out it will switch to minutes and seconds. At the end time the screen goes red, and it will start counting up so you know how much over time you are. +It will count down the minutes until the end time. The screen will stay awake for the entire time that the timer is visible. At 2 minutes out it will switch to minutes and seconds. At the end time the screen goes red, and it will start counting up so you know how much over time you are. -To get out of the timer screen, swipe down from the top to get your navigation buttons back. I got lazy and used 'sticky immersive' mode which will automatically hide the navigation buttons after a few seconds. This saved me from having to write my own fullscreen toggle, but does mean you have to use the swipe down to get to the navigation bars which is a bit annoying (particularly if you don't know about it). \ No newline at end of file +To get out of the timer screen, swipe down from the top of the screen to get your navigation buttons back. I used 'sticky immersive' mode for the timer screen which will automatically hide the navigation buttons after a few seconds. This saved me from having to write my own fullscreen toggle, but does mean you have to swipe down from the top of the screen to get to the navigation bars which is a bit annoying (particularly if you don't know about it). \ No newline at end of file