From b3b551c877b3d5893fcfcbf4875acdaa5d545925 Mon Sep 17 00:00:00 2001
From: louie <lshprung@yahoo.com>
Date: Sun, 20 Sep 2020 09:46:33 -0700
Subject: Added README

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

(limited to 'docs/README.md')

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..a963973
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,21 @@
+## About
+
+This is a simple yahtzee game I wrote in the Summer of 2019 when I was learning Web Development and Javascript. As it was a learning exercise, it is not particularly polished, and you may encounter some janky CSS.
+
+## Setup
+
+Clone the repository:
+
+```
+git clone https://github.com/lshprung/yahtzee-js.git
+```
+
+Navigate to the directory the repo was cloned into and start a localhost PHP server. I use port 8000 in this example:
+
+```
+php -S localhost:8000
+```
+
+Now open a web browser and enter the following URL: `http://localhost:8000/yahtzee.html`. If everything went right, you should see the following:
+
+![demonstration screenshot](demo.png)
-- 
cgit