From fed3209c5803b5d10a004102b7059576585a3379 Mon Sep 17 00:00:00 2001 From: Johannes Loher Date: Wed, 6 Jan 2021 03:22:25 +0100 Subject: [PATCH] update the readme --- README.md | 73 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 56 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 8119bbdb..4222e363 100644 --- a/README.md +++ b/README.md @@ -3,50 +3,89 @@ An implementation of the Dungeonslayers 4 game system for [Foundry Virtual Tabletop](http://foundryvtt.com). -## Prerequisites +This system provides character sheet support for Actors and Items and mechanical +support for dice and rules necessary to +play games of Dungeponslayers 4. -In order to build this system, a recent version of `npm` is required. +## Installation -## Building +To install and use the Dungeonslayers 4 system for Foundry Virtual Tabletop, +simply paste the following URL into the **Install System** dialog on the Setup +menu of the application. -To build the system, first install all required dependencies: +https://git.f3l.de/dungeonslayers/ds4/-/raw/master/src/system.json?inline=false + +## Development + +### Prerequisits + +In order to build this system, recent versions of `node` and `npm` are required. +We recommend using the latest lts version of `node`, which is `v14.15.4` at the +time of writing. If you use `nvm` to manage your `node` versions, you can simply +run +``` +nvm install +``` + +in the project's root directory. + +You also need to install the the project's dependencies. To do so, run ``` npm install ``` -Then build the project by running +### Building + +You can 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: +Alternatively, you can run + +``` +npm run build:watch +``` + +to watch for changes and automatically build as necessary. + +### Linking the built system to Foundry VTT + +In order to provide a fluent development experience, it is recommended to link +the built system to your local Foundry VTT installation's data folder. In order +to do so, first add a file called `foundryconfig.json` to the project root with +the following content: ``` { - "dataPath": "//.local/share/FoundryVTT", - "repository": "", - "rawURL": "" + "dataPath": "/.local/share/FoundryVTT" } ``` +On platforms other than Linux you need to adjust the path accordingly. + Then run ``` npm run link ``` -If you want the system to be continuously build upon every saved change, just -run +### Running the tests + +You can run the tests with the following command: ``` -npm run build:watch +npm test ``` -# Licensing +## Contributing + +Code and content contributions are accepted. Please feel free to submit issues +to the issue tracker or submit merge requests for code changes. + +## Licensing Dungeonslayers (© Christian Kennig) is licensed under [CC BY-NC-SA 3.0](https://creativecommons.org/licenses/by-nc-sa/3.0/de/deed.en). @@ -56,5 +95,5 @@ CC BY-NC-SA 3.0. Hence the modified icons are also published under this license. A copy of this license can be found under [src/assets/official/LICENSE](src/assets/official/LICENSE). -The rest of this project is licensed under the MIT License, a copy of which can -be found under [LICENSE](LICENSE). +The software component of this project is licensed under the MIT License, a copy +of which can be found under [LICENSE](LICENSE).