Skip to content

Commit 15a2311

Browse files
Added a few finer points.
1 parent 73f45b7 commit 15a2311

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
[![Build status](https://ci.appveyor.com/api/projects/status/8oj3j7u6nvag1xvu/branch/master?svg=true)](https://ci.appveyor.com/project/zhengbli/tsjs-lib-generator/branch/master)
44

5-
This tool is used to generate `dom.generated.d.ts` and `webworker.generated.d.ts` for TypeScript, and `domWeb.js` and `domWindows.js` for Visual Studio JavaScript language service. The input file is the XML spec file generated by the Microsoft Edge browser.
5+
This tool is used to generate `dom.generated.d.ts` and `webworker.generated.d.ts` for TypeScript, and `domWeb.js` and `domWindows.js` for Visual Studio JavaScript language service.
6+
The input file is the XML spec file generated by the Microsoft Edge browser.
67

78
## Build Instructions
89

@@ -32,7 +33,7 @@ The common steps to send a pull request are:
3233

3334
- `Shared.fs`: handles the parsing from XML spec file, and stores the common data structures for later use.
3435
- `TS.fs`: handles the emitting of the `lib.d.ts` file.
35-
- `JS.fs`: handles the emitting of the `domWeb.js` and `domWindows.js`
36+
- `JS.fs`: handles the emitting of the `domWeb.js` and `domWindows.js`.
3637

3738
## Input Files
3839

@@ -42,6 +43,6 @@ The common steps to send a pull request are:
4243
- `addedTypes.json`: types that should exist in either browser or webworker but are missing from the Edge spec. The type can be `property`, `method`, `interface`, `constructor`, or `indexer`.
4344
- `overridingTypes.json`: types that are defined in the spec file but has a better or more up-to-date definitions in the json files.
4445
- `removedTypes.json`: types that are defined in the spec file but should be removed.
45-
- `comments.json`: comment strings to be embedded in the generated .js files
46+
- `comments.json`: comment strings to be embedded in the generated .js files.
4647
- `jsTemplate.js`: the initial templates for `domWeb.js` and `domWindows.js`, which contains the necessary helper functions.
4748
- `sample.json`: sample json file used to tell F# json type provider that structure of the json files. The content of it is not used anywhere.

0 commit comments

Comments
 (0)