aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Makefile21
-rw-r--r--README.md13
-rw-r--r--example_businesshours4
3 files changed, 22 insertions, 16 deletions
diff --git a/Makefile b/Makefile
index b457b26..fc74b7b 100644
--- a/Makefile
+++ b/Makefile
@@ -9,9 +9,14 @@ install:
read -p $$'\033[1mWhere do you want to install? (default: /usr/local) \033[0m' prefix; \
fi; \
if [[ ! $$prefix ]]; then prefix="/usr/local"; fi; \
+ echo $$'\033[1mInstalling...\033[0m'; \
mkdir -pv $$prefix/bin $$prefix/share/man/man1 \
&& cp -v nowopen $$prefix/bin/ \
- && cp -v doc/nowopen.1 $$prefix/share/man/man1/;
+ && cp -v doc/nowopen.1 $$prefix/share/man/man1/; \
+ xdg_data_home=$$XDG_DATA_HOME; \
+ if [[ ! $$xdg_data_home ]]; then xdg_data_home="~/.local/share"; fi; \
+ echo $$'\033[1mInstallation complete.\033[0m'; \
+ echo "Put your business hours file in either $$xdg_data_home/nowopen/businesshours or ~/.businesshours";
uninstall:
@prefix="$(PREFIX)"; \
@@ -19,14 +24,10 @@ uninstall:
read -p $$'\033[1mWhere do you want to uninstall from? (default: /usr/local) \033[0m' prefix; \
fi; \
if [[ ! $$prefix ]]; then prefix="/usr/local"; fi; \
- echo "Deleting..."; \
+ echo $$'\033[1mDeleting...\033[0m'; \
+ rm -rvf $$prefix/bin/nowopen $$prefix/share/man/man1/doc/nowopen.1; \
xdg_data_home=$$XDG_DATA_HOME; \
- if [[ ! $$xdg_data_home ]]; then $$xdg_data_home = "~/.local/share"; fi; \
- for f in $$xdg_data_home/nowopen ~/.businesshours; do \
- if [[ -f $$f || -d $$f ]]; then \
- read -p "Do you want to delete $$f? (Y/n) " confirm; \
- if [[ confirm -ne "n" ]]; then rm -rvf $$f; fi; \
- fi; \
- done; \
- rm -rvf $$prefix/bin/nowopen $$prefix/share/man/man1/doc/nowopen.1;
+ if [[ ! $$xdg_data_home ]]; then xdg_data_home="~/.local/share"; fi; \
+ echo $$'\033[1mUninstallation complete.\033[0m'; \
+ echo "You may want to delete your data from $$xdg_data_home/nowopen/businesshours or ~/.businesshours";
diff --git a/README.md b/README.md
index f4237ae..ed27ba1 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,13 @@
`nowopen` is a simple program to display which places are currently open.
-## Usage
-
-First, create a file with business hours in it at either `~/.local/share/nowopen/businesshours`
-(recommended) or `~/.businesshours`. An example businesshours file is provided.
-The format looks like:
+## Installing
+`sudo make install` to install, and `sudo make uninstall` to uninstall.
+You should also create a file to store business hours in at either
+`~/.local/share/nowopen/businesshours` (recommended) or `~/.businesshours`.
+An example businesshours file is provided, so you can get started by
+running `mkdir -p ~/.local/share/nowopen && cp example_businesshours ~/.local/share/nowopen/businesshours`.
+The businesshours format looks like:
```
Mario Bros Plumbing (plumbers):
@@ -14,6 +16,7 @@ Mario Bros Plumbing (plumbers):
sun: closed
```
+## Usage
Once you have a businesshours file, run `nowopen [-p] [tag1 tag2...]`. Establishments
matching any of the specified tags (prefix matching is used) and the amount of
time till they close will be displayed. E.g. `nowopen plumber` will show how long
diff --git a/example_businesshours b/example_businesshours
index 7b36da3..98bb653 100644
--- a/example_businesshours
+++ b/example_businesshours
@@ -1,4 +1,6 @@
-# Line comments with "#"
+# This is an example businesshours file
+# You should replace it with the business hours you want
+# and save it to ~/.local/share/nowopen/businesshours
Jimmy Pesto's Pizzeria (restaurant, pizza, delivery):
11am-midnight
fri-sat: 11am-1am