You've already forked UsageHelpr
mirror of
https://github.com/FullScreenShenanigans/UsageHelpr.git
synced 2026-04-28 13:03:13 -07:00
Josh Goldberg
26 lines
902 B
Markdown
26 lines
902 B
Markdown
# UsageHelpr
|
|
[](https://travis-ci.org/FullScreenShenanigans/UsageHelpr)
|
|
[](http://badge.fury.io/js/usagehelpr)
|
|
|
|
A simple interactive text-based assistant to demonstrate common API uses.
|
|
|
|
|
|
## Build Process
|
|
|
|
UsageHelpr uses [Gulp](http://gulpjs.com/) to automate building, which requires [Node.js](http://node.js.org).
|
|
|
|
To build from scratch, install NodeJS and run the following commands:
|
|
|
|
```
|
|
npm install
|
|
gulp
|
|
```
|
|
|
|
### Individual Gulp tasks
|
|
|
|
* `gulp dist` - Compiles the source into `dist/`.
|
|
* `gulp tsc` - Runs the [TypeScript](https://typescriptlang.org/) compiler.
|
|
* `gulp tslint` - Runs [TSLint](https://github.com/palantir/tslint).
|
|
* `gulp test` - Runs tests in `tests/`.
|
|
* `gulp watch` - Runs the `tsc` and `tslint` tasks when a source file changes.
|