From 8384444bfb44dfc5907ba7cd34652c31cd5ed18f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Lemaire?= Date: Sun, 15 Jan 2017 12:45:18 +0100 Subject: [PATCH] Updated README --- .gitignore | 2 +- .vscode/settings.json | 4 ++++ .vscode/tasks.json | 25 +++++++++++++++++++++++++ README.md | 12 ++++++++++++ package.json | 7 ++++--- 5 files changed, 46 insertions(+), 4 deletions(-) create mode 100644 .vscode/settings.json create mode 100644 .vscode/tasks.json diff --git a/.gitignore b/.gitignore index ccc1bdb..abd0841 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -.* +.env coverage /node_modules /out/vendor diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..61ae0f7 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,4 @@ +{ + "typescript.check.workspaceVersion": false, + "typescript.tsdk": "./node_modules/typescript/lib" +} \ No newline at end of file diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..072d75a --- /dev/null +++ b/.vscode/tasks.json @@ -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" + } + ] +} \ No newline at end of file diff --git a/README.md b/README.md index 5780754..8c970b2 100644 --- a/README.md +++ b/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 diff --git a/package.json b/package.json index f280f45..53aedd0 100644 --- a/package.json +++ b/package.json @@ -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": {