dungeonslayers/ds4
dungeonslayers/ds4
3
0
Fork 0
Code Issues 9 Pull requests 7 Projects Releases 10 Packages 1 Activity

Update README.md and package.json

Browse source
This commit is contained in:
Johannes Loher 2021-02-11 13:57:14 +01:00
parent af07168c5b
commit 0dde280d39
2 changed files with 13 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -18,10 +18,12 @@ https://git.f3l.de/dungeonslayers/ds4/-/raw/latest/src/system.json?inline=false
### Prerequisites
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
In order to build this system, recent versions of `node` and `yarn` are
required. Most likely using `npm` also works but only `yarn` is officially
supported. We recommend using the latest lts version of `node`, which is
`v14.15.5` at the time of writing. If you use `nvm` to manage your `node`
versions, you can simply run
```
nvm install
```
@ -31,7 +33,7 @@ in the project's root directory.
You also need to install the the project's dependencies. To do so, run
```
npm install
yarn install
```
### Building
@ -39,13 +41,13 @@ npm install
You can build the project by running
```
npm run build
yarn build
```
Alternatively, you can run
```
npm run build:watch
yarn build:watch
```
to watch for changes and automatically build as necessary.
@ -68,7 +70,7 @@ On platforms other than Linux you need to adjust the path accordingly.
Then run
```
npm run link
yarn link-project
```
### Running the tests
@ -76,7 +78,7 @@ npm run link
You can run the tests with the following command:
```
npm test
yarn test
```
## Contributing

4
package.json
View file

@ -33,9 +33,9 @@
"scripts": {
"build": "gulp build",
"build:watch": "gulp watch",
"link": "gulp link",
"link-project": "gulp link",
"clean": "gulp clean && gulp link --clean",
"update": "npm install --save-dev github:League-of-Foundry-Developers/foundry-vtt-types#foundry-0.7.9",
"update": "yarn add --dev foundry-vtt-types@github:League-of-Foundry-Developers/foundry-vtt-types#foundry-0.7.9",
"updateManifest": "gulp updateManifest",
"lint": "eslint 'src/**/*.ts' --cache",
"lint:fix": "eslint 'src/**/*.ts' --cache --fix",