add README.md

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 @@
+# 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`.