Skip to content

Commit 7587b2c

Browse files
authored
Add basic doc and support VSCode build (#2)
1 parent 9c6d289 commit 7587b2c

File tree

4 files changed

+67
-1
lines changed

4 files changed

+67
-1
lines changed

.vscode/settings.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"typescript.check.workspaceVersion": false
3+
}

.vscode/tasks.json

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
// See https://go.microsoft.com/fwlink/?LinkId=733558
3+
// for the documentation about the tasks.json format
4+
"version": "0.1.0",
5+
"command": "gulp",
6+
"isShellCommand": true,
7+
"args": [
8+
"--no-color"
9+
],
10+
"tasks": [
11+
{
12+
"taskName": "build",
13+
"args": [],
14+
"isBuildCommand": true,
15+
"isWatching": false,
16+
"problemMatcher": [
17+
"$lessCompile",
18+
"$tsc",
19+
"$jshint"
20+
]
21+
}
22+
]
23+
}

README.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## Set up Node, npm, gulp and typings
2+
3+
### Node and npm
4+
**Windows and Mac OSX**: Download and install node from [nodejs.org](http://nodejs.org/)
5+
6+
**Linux**: Install [using package manager](https://nodejs.org/en/download/package-manager/)
7+
8+
From a terminal ensure at least node 5.4.1 and npm 3:
9+
```bash
10+
$ node -v && npm -v
11+
v5.9.0
12+
3.8.2
13+
```
14+
**Note**: To get npm version 3.8.2, you may need to update npm after installing node. To do that:
15+
```bash
16+
[sudo] npm install npm -g
17+
```
18+
19+
### Gulp
20+
Install gulp
21+
```bash
22+
[sudo] npm install gulp -g
23+
```
24+
From the root of the repo, install all of the build dependencies:
25+
```bash
26+
[sudo] npm install --greedy
27+
```
28+
29+
### Typings
30+
#### Install Typings CLI utility
31+
`npm install typings --global`
32+
33+
#### Install required typings to build this project
34+
`typings install`
35+
36+
## Build project
37+
Type `gulp build` from the command line or run build inside VSCode
38+

gulpfile.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,6 @@ gulp.task('compile', () => {
1818

1919
gulp.task('clean', () => {
2020
return del(['**/*.js', '**/*.d.ts', '!node_modules/**/*', '!gulpfile.js', '!typings/**/*', '!libs/**/*'])
21-
});
21+
});
22+
23+
gulp.task('build', gulp.series('clean', 'compile'));

0 commit comments

Comments
 (0)