summaryrefslogtreecommitdiff
path: root/README.md
blob: 1931e07c2798821e26e2c97232f63c1d6baf8390 (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
33
34
35
36
37
# Cosmic Countdown

A countdown to the new year based on Carl Sagan's Cosmic Calendar.

A year-long meditation on the scope of time.

## Building

First you need `stack` installed. You can install `stack` by running
`make install-stack`. This requires `curl` and root access via `sudo`.
Alternatively, you can follow the instructions here:
https://docs.haskellstack.org/en/stable/

Type `make` to build.

## Running

Type `make run` to build and then run.

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

## Using

Use `p` to pause the clock.

Use `,` and `.` to navigate between calendar entries (mnemonic: `<` and `>`).

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 of time. For details about keybindings, see the
`handleEvent` function in the source file `countdown.hs`.