diff options
-rw-r--r-- | README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..165479b --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,32 @@ | |||
1 | # Cosmic Countdown | ||
2 | |||
3 | A countdown timer based on Carl Sagan's Cosmic Calendar. | ||
4 | |||
5 | ## Building | ||
6 | |||
7 | Type `make` to build. | ||
8 | |||
9 | You need stack already installed. https://docs.haskellstack.org/en/stable/ | ||
10 | |||
11 | ## Running | ||
12 | |||
13 | Type `make run` to build and then run. | ||
14 | |||
15 | Or type `make install` and then run `countdown`. Make sure `$HOME/.local/bin` is | ||
16 | in your `$PATH` environment variable. | ||
17 | |||
18 | ## Using | ||
19 | |||
20 | Use `p` to pause the clock. | ||
21 | |||
22 | Use `,` and `.` to navigate between calendar entries. | ||
23 | |||
24 | To jump forward and backward in time by one day, use `PgUp` and `PgDown`. | ||
25 | |||
26 | Press `Home` to jump to the current time. | ||
27 | |||
28 | Press `End` to jump to the New Year's Eve final countdown. | ||
29 | |||
30 | You can also use the arrow keys with or without modifiers to jump forward and | ||
31 | backward by different amounts. For details about keybindings, see the | ||
32 | `handleEvent` function in the source file `countdown.hs`. | ||