diff options
| author | John J. Camilleri <john@digitalgrammars.com> | 2019-06-10 10:19:43 +0200 |
|---|---|---|
| committer | John J. Camilleri <john@digitalgrammars.com> | 2019-06-10 10:19:43 +0200 |
| commit | 6a9c917b2914520b593af073e4fbf533e2f83676 (patch) | |
| tree | fdf3b471d9d1ce924e53d61766b24c71bb18e3f9 /src/runtime | |
| parent | 9ba4a42426b43ff7f7f19ca0ba4f74b175b9b84a (diff) | |
TypeScript readme
Diffstat (limited to 'src/runtime')
| -rw-r--r-- | src/runtime/typescript/README.md | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/src/runtime/typescript/README.md b/src/runtime/typescript/README.md index 7f796a63b..e7905af89 100644 --- a/src/runtime/typescript/README.md +++ b/src/runtime/typescript/README.md @@ -2,7 +2,7 @@ `gflib.ts` is a TypeScript implementation of the GF runtime. It is ported from an older JavaScript implementation [`gflib.js`](../javascript/gflib.js), -with some small improvements. +with some improvements. Importantly, all **future** updates will only be made to this TypeScript version. @@ -15,11 +15,16 @@ So its features are limited and it is not efficient, making it really only usefu ## Using `gflib.ts` can be transpiled to JavaScript by running `tsc` in this folder (of course you need TypeScript installed). -It has no module depenedencies. -You can then include the generated `gflib.js` file in your application as usual. +It has no module dependencies. +You can then include the generated `js/gflib.js` file in your application as usual. + +_This generated JavaScript version is also included under version control, +to make it easy for someone to use without having to install TypeScript._ Your GF grammar should be compiled with: `gf --make --output-format=js` +For an example of a working web application using the JavaScript runtime, see `../javascript`. + ## What happened to `gflib.d.ts`? There was once a file here called `gflib.d.ts`, which contained TypeScript type definitions for the **old** `gflib.js`. |