summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrew Cady <d@cryptonomic.net>2022-09-22 00:06:17 -0400
committerAndrew Cady <d@cryptonomic.net>2022-09-22 00:06:17 -0400
commiteb4522fbc1487b6bdaff379aa18d3530876b2581 (patch)
tree08692287753567069f5cf30ca60a8c3f70e0a373
parent05e4647d7bef90f7b095bc24ba14701392b415ec (diff)
add "make install-stack" target and update README
-rw-r--r--Makefile3
-rw-r--r--README.md13
2 files changed, 11 insertions, 5 deletions
diff --git a/Makefile b/Makefile
index cfb1ff6..b082c3d 100644
--- a/Makefile
+++ b/Makefile
@@ -2,6 +2,9 @@ all:
2 stack build 2 stack build
3 ln -sfT $$(stack path --local-install-root)/bin ./bin 3 ln -sfT $$(stack path --local-install-root)/bin ./bin
4 4
5install-stack:
6 curl -sSL https://get.haskellstack.org/ | sh
7
5.PHONY: all run install install-dev-tools 8.PHONY: all run install install-dev-tools
6 9
7run: all 10run: all
diff --git a/README.md b/README.md
index 165479b..5bbaab3 100644
--- a/README.md
+++ b/README.md
@@ -4,22 +4,25 @@ A countdown timer based on Carl Sagan's Cosmic Calendar.
4 4
5## Building 5## Building
6 6
7Type `make` to build. 7First you need `stack` installed. You can install `stack` by running
8`make install-stack`. This requires `curl` and root access via `sudo`.
9Alternatively, you can follow the instructions here:
10https://docs.haskellstack.org/en/stable/
8 11
9You need stack already installed. https://docs.haskellstack.org/en/stable/ 12Type `make` to build.
10 13
11## Running 14## Running
12 15
13Type `make run` to build and then run. 16Type `make run` to build and then run.
14 17
15Or type `make install` and then run `countdown`. Make sure `$HOME/.local/bin` is 18Or type `make install` and then run `countdown`. You need `$HOME/.local/bin`
16in your `$PATH` environment variable. 19in your `$PATH` environment variable.
17 20
18## Using 21## Using
19 22
20Use `p` to pause the clock. 23Use `p` to pause the clock.
21 24
22Use `,` and `.` to navigate between calendar entries. 25Use `,` and `.` to navigate between calendar entries (mnemonic: `<` and `>`).
23 26
24To jump forward and backward in time by one day, use `PgUp` and `PgDown`. 27To jump forward and backward in time by one day, use `PgUp` and `PgDown`.
25 28
@@ -28,5 +31,5 @@ Press `Home` to jump to the current time.
28Press `End` to jump to the New Year's Eve final countdown. 31Press `End` to jump to the New Year's Eve final countdown.
29 32
30You can also use the arrow keys with or without modifiers to jump forward and 33You can also use the arrow keys with or without modifiers to jump forward and
31backward by different amounts. For details about keybindings, see the 34backward by different amounts of time. For details about keybindings, see the
32`handleEvent` function in the source file `countdown.hs`. 35`handleEvent` function in the source file `countdown.hs`.