Skip to content

Commit db8d3b8

Browse files
committed
doc(readme): describe gulp tasks
fixes dart-archive#212
1 parent c0d5579 commit db8d3b8

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,15 @@
33

44
ts2dart is a TypeScript to Dart transpiler. It's in its very early days and under heavy development,
55
not ready for production use.
6+
7+
## Installation
8+
9+
- execute `npm i` to install the dependencies,
10+
- the Dart SDK must be available to run end to end tests.
11+
12+
## Gulp tasks
13+
14+
- `gulp watch` executes the unit tests in watch mode (use `gulp test.unit` for a single run),
15+
- `gulp test.e2e` executes the e2e tests,
16+
- `gulp test.check-format` checks the source code formatting using `clang-format`,
17+
- `gulp test` runs unit tests, e2e tests and checks the source code formatting.

0 commit comments

Comments
 (0)