From 1bcf95d280f177cd462eea5bd8829dafe945ba76 Mon Sep 17 00:00:00 2001
From: Kiana Sheibani <54818348+kiana-S@users.noreply.github.com>
Date: Wed, 29 Dec 2021 20:58:10 -0500
Subject: [PATCH] Create README.md

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e2a6322
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Conway's Game of Life
+
+An implementation of Conway's Game of Life in Haskell using
+comonads and functional reactive programming.
+
+This package consists of two parts:
+
+- A library that can be used to simulate Conway's Game of Life on an arbitrary space
+  using arbitrary rules. It is based on a comonad transformer stack.
+
+- An executable that uses [Yampa](https://hackage.haskell.org/package/Yampa) and
+  [Gloss](https://hackage.haskell.org/package/gloss-1.13.0.1) to graphically display
+  a 100x100 simulation of Conway's Game of Life. The simulation can be controlled by the keys:
+  
+  `Space` – Play/Pause
+  
+  `-` – Slow down the tick rate
+
+  `+` (hold shift) – Speed up the tick rate
+
+This package is a work in progress and may not be fully functional.