Updated README
This commit is contained in:
parent
76253dece4
commit
8384444bfb
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -1,4 +1,4 @@
|
|||
.*
|
||||
.env
|
||||
coverage
|
||||
/node_modules
|
||||
/out/vendor
|
||||
|
|
4
.vscode/settings.json
vendored
Normal file
4
.vscode/settings.json
vendored
Normal file
|
@ -0,0 +1,4 @@
|
|||
{
|
||||
"typescript.check.workspaceVersion": false,
|
||||
"typescript.tsdk": "./node_modules/typescript/lib"
|
||||
}
|
25
.vscode/tasks.json
vendored
Normal file
25
.vscode/tasks.json
vendored
Normal file
|
@ -0,0 +1,25 @@
|
|||
{
|
||||
"version": "0.1.0",
|
||||
"command": "./npm",
|
||||
"isShellCommand": true,
|
||||
"args": [
|
||||
"run",
|
||||
"--silent"
|
||||
],
|
||||
"tasks": [
|
||||
{
|
||||
"taskName": "build",
|
||||
"isBuildCommand": true,
|
||||
"isTestCommand": false,
|
||||
"showOutput": "always",
|
||||
"problemMatcher": "$tsc"
|
||||
},
|
||||
{
|
||||
"taskName": "test",
|
||||
"isBuildCommand": false,
|
||||
"isTestCommand": true,
|
||||
"showOutput": "always",
|
||||
"problemMatcher": "$tsc"
|
||||
}
|
||||
]
|
||||
}
|
12
README.md
12
README.md
|
@ -9,6 +9,18 @@
|
|||
|
||||
*Play directly in your browser, no download or dependency required.*
|
||||
|
||||
## How to develop
|
||||
|
||||
If you want to build on your computer, clone the repository, then run:
|
||||
|
||||
npm install # Install dependencies
|
||||
npm test # Run unit tests
|
||||
rpm start # Start development server, and open game in web browser
|
||||
|
||||
After making changes to sources, you need to recompile:
|
||||
|
||||
npm run build
|
||||
|
||||
## Attributes
|
||||
|
||||
* **Initiative** - Ability to play before other ships in the play order
|
||||
|
|
|
@ -4,11 +4,12 @@
|
|||
"description": "A tactical RPG set in space",
|
||||
"main": "src/build.js",
|
||||
"scripts": {
|
||||
"deps": "bower install && typings install",
|
||||
"postinstall": "bower install && typings install",
|
||||
"build": "tsc -p .",
|
||||
"pretest": "tsc -p .",
|
||||
"test": "karma start spec/support/karma.conf.js && remap-istanbul -i out/coverage/coverage.json -o out/coverage -t html",
|
||||
"build-test": "npm run build && npm run test",
|
||||
"serve": "live-server out --host=127.0.0.1 --port=8012 --ignore=coverage",
|
||||
"prestart": "tsc -p .",
|
||||
"start": "live-server out --host=127.0.0.1 --port=8012 --ignore=coverage",
|
||||
"codecov": "remap-istanbul -i out/coverage/coverage.json -o out/coverage/mapped.json -t json && codecov -f out/coverage/mapped.json"
|
||||
},
|
||||
"repository": {
|
||||
|
|
Loading…
Reference in a new issue