Add README.md

This commit is contained in:
Johannes Loher 2020-12-23 18:48:32 +01:00
parent a47ed4d26c
commit e79c57d1d1

41
README.md Normal file
View file

@ -0,0 +1,41 @@
# DS4
An implementation of the Dungeonslayers 4 game system for Foundry Virtual
Tabletop (http://foundryvtt.com).
## Prerequisites
In order to build this system, a recent version of `npm` is required.
## Building
To build the system, first install all required dependencies:
```
npm install
```
Then build the project by running
```
npm run build
```
If you'd like the built system to be automatically linked to your local Foundry
VTT installation's data folder, add a file called `foundryconfig.json` to the
project root with the following contents befor building:
```
{
"dataPath": "/home/johannesloher/.local/share/FoundryVTT",
"repository": "",
"rawURL": ""
}
```
If you want the system to be continuously build upon every saved change, just
run
```
npm run build:watch
```