-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |