From 5591e0a904ff709af9272d412f73b89d705ca9ee Mon Sep 17 00:00:00 2001
From: bertieb <git@bertieb.org>
Date: Fri, 19 Feb 2021 11:12:17 +0000
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2b25c82
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# Dice Roller
+
+This project simulates rolling dice and collecting results (like [AnyDice](https://anydice.com/)).
+
+It is mostly of interest to simulate the rolling of a particular kind of dice -- Asphodice -- which is not possible in AnyDice.
+
+## Installation
+
+This package relies on node for package management and gulp for the build pipeline. `npm install` should install dependencies. From there, `tsc` will transpile from TypeScript to JavaScript; or `gulp` will start a BrowserSync instance for developing the frontend, running at http://localhost:3000/. `npm test` will run the test suite.