Skip to content

Commit 9cd78d7

Browse files
updated readme
1 parent d775fa8 commit 9cd78d7

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

typescript/readme.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
# TypeScript Definitions #
22

3-
If you are a phaser dev, just grab the whole directory as is. It is setup with sibling references and is the easiest way to get full typed support. Otherwise:
3+
If you are a phaser dev then reference the `phaser.d.ts` in your project.
44

5-
- `phaser.plugins.x.d.ts` depend on `phaser.d.ts` and are optional.*
6-
- `phaser.d.ts` depends on `pixi.d.ts` and so both these files are needed
7-
- `pixi.d.ts` has no dependicies and can be used by pixi devs**
5+
- `phaser.d.ts` contains a reference to `pixi.d.ts` and so both these files must remain siblings in the same directory.
6+
- `pixi.d.ts` has no dependencies and can be used by pixi devs standalone**
87

98
*If creating a third party plugin definition. Please add a reference path to point at phaser `/// <reference path="phaser.d.ts" />`
109

11-
**Versions of TypeScript lower than version 1.0 may experience errors in `pixi.d.ts` due to missing WebGL definitions. If you fall into this category then a `webgl.d.ts` has been provided but is disabled by default. Add this line to the top of the pixi.d.ts file `/// <reference path="webgl.d.ts" />` to fix the type errors.
10+
**Versions of TypeScript lower than version 1.0 may experience errors in `pixi.d.ts` due to missing WebGL definitions. If you fall into this category and cannot upgrade your version, then a `webgl.d.ts` has been provided but is disabled by default. Add this line to the top of the `pixi.d.ts` file `/// <reference path="webgl.d.ts" />`
11+
12+
## Contributing ##
13+
14+
If you find any mistakes in these definitions or you feel they can be improved in any way, please make a pull request against the dev branch.

0 commit comments

Comments
 (0)