Skip to content

Commit 239aabe

Browse files
committed
README: add "Development" section
1 parent 779daa6 commit 239aabe

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,20 @@ Further reading:
1616
* [About API implemented in this library](http://doc.kaitai.io/stream_api.html)
1717
* [JavaScript-specific notes](http://doc.kaitai.io/lang_javascript.html) - also includes Quick start guide
1818

19+
## Development
20+
21+
After cloning this repository, you must run these commands to compile the
22+
TypeScript source file [`KaitaiStream.ts`](./KaitaiStream.ts) into the
23+
`KaitaiStream.js` file (ignored by Git) with JavaScript code:
24+
25+
```shell
26+
npm install
27+
npm run build
28+
```
29+
30+
`npm run build` also needs to be run after each change to
31+
[`KaitaiStream.ts`](./KaitaiStream.ts).
32+
1933
## Licensing
2034

2135
Copyright 2012-2016 Ilmari Heikkinen\

0 commit comments

Comments
 (0)