Browse Source

Add README

tags/v0.1.3
bertieb 3 years ago
parent
commit
5591e0a904
1 changed files with 9 additions and 0 deletions
  1. +9
    -0
      README.md

+ 9
- 0
README.md View File

@@ -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.

Loading…
Cancel
Save