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