Skip to content

Commit

Permalink
Add basic readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tom-wolfe committed Dec 12, 2017
1 parent b39947d commit 64957c7
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# This Is Your Life

This is a simple generator that automates the process of generating a Dungeons & Dragons 5th Edition character based on the random tables in the Player Handbook, Volo's Guide to Monsters, Xanathar's Guide to Everything and accompanying material.

## Initializing

Run `npm i` to install all required dependencies before running the development server.

## Development server

Run `npm run test` for a dev server. Navigate to `http://localhost:8080/`. The app will automatically reload if you change any of the source files.

## Build

Run `npm run build` to build the project. The build artifacts will be stored in the `dist/` directory.

## Running unit tests

Run `npm test` to execute the unit tests via [Jasmine](https://jasmine.github.io/).

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/trwolfe13/brewdown/tags).

## Authors

* **Tom Wolfe** - *Initial work* - [trwolfe13](https://github.com/trwolfe13)

See also the list of [contributors](https://github.com/trwolfe13/this-is-your-life/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

0 comments on commit 64957c7

Please sign in to comment.