generated from me/template-mit
README, updates to make it a better prompt.
This commit is contained in:
1 parent
f145f7122e
commit
eb0555fd77
1 file changed
+17
-10
@@ -1,6 +1,8 @@
|
||||
# Sunset Alarm (CLI)
|
||||
|
||||
Command line Sunset Alarm app which can be run as a user daemon.
|
||||
Simple command line shell script which can be run as a user daemon for alerts.
|
||||
|
||||
## Description
|
||||
|
||||
Sunset Alarm allows a user to receive an alert at a specified amount of minutes
|
||||
before sunset. This may be helpful for starting any practices such as preparing
|
||||
@@ -69,12 +71,12 @@ echo "exec --no-startup-id /usr/local/bin/sunset-alarm -l 33:-112 -m 15" >> ~/.c
|
||||
|
||||
## Parameters
|
||||
|
||||
**Required**
|
||||
### Required
|
||||
|
||||
-m : Accepts a minute value which is used to check if we have approached the
|
||||
alert period before sunset. Can be positive, negative, or 0.
|
||||
|
||||
**Optional**
|
||||
### Optional
|
||||
|
||||
-l : Accepts a lat:long value which is used to check Open Meteo for the
|
||||
location's sunset time. This is required if -t is not passed.
|
||||
@@ -85,12 +87,17 @@ required to know when to alert prior to this time.
|
||||
|
||||
## Design
|
||||
|
||||
App displays a persistent alert via channels such as `fyi` or `notify-send` once
|
||||
the current time is between (sunset - minutes) and midnight. Even if the system
|
||||
is powered on after the alert time has passed, the program should display the
|
||||
alert until the day has passed.
|
||||
App displays a persistent alert via `fyi` with fallbacks of `notify-send`,
|
||||
`wall`, and others. Appears once when current time is between (sunset - minutes)
|
||||
and midnight. Even if the system is powered on after the alert time has passed,
|
||||
the program continues displaying the alert repeatedly until the day has passed.
|
||||
|
||||
App requires an internet connection. If no connection is found, it sleeps for 5
|
||||
minutes and then tries again to retrieve the sunset time. Once the sunset time has
|
||||
been retrieved for the current day, it stops checking Open Meteo until the next
|
||||
day.
|
||||
minutes and then tries again to retrieve the sunset time. Once the sunset time
|
||||
has been retrieved for the day, it stops checking Open Meteo until the next day.
|
||||
|
||||
App is short, sweet, concise, and succinct without using any odd syntax or line
|
||||
combining to achieve this. Does not pull in any extraneous libraries, only uses
|
||||
utilities which are already installed on the system. Program is coded to use a
|
||||
range of utilities in case the primary choices are not available. If no choices
|
||||
are installed, displays an ERROR message with a list of software to download.
|
||||
Reference in new issue
Block a user