summaryrefslogtreecommitdiff
path: root/README.md
blob: 165479becb1b7b55867dcde82b43b5f4c7fdfe33 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# Cosmic Countdown

A countdown timer based on Carl Sagan's Cosmic Calendar.

## Building

Type `make` to build.

You need stack already installed.  https://docs.haskellstack.org/en/stable/

## Running

Type `make run` to build and then run.

Or type `make install` and then run `countdown`. Make sure `$HOME/.local/bin` is
in your `$PATH` environment variable.

## Using

Use `p` to pause the clock.

Use `,` and `.` to navigate between calendar entries.

To jump forward and backward in time by one day, use `PgUp` and `PgDown`.

Press `Home` to jump to the current time.

Press `End` to jump to the New Year's Eve final countdown.

You can also use the arrow keys with or without modifiers to jump forward and
backward by different amounts. For details about keybindings, see the
`handleEvent` function in the source file `countdown.hs`.