From 3ae6a6d407fc1f4d54b1f27ecd6738bf1de89eb4 Mon Sep 17 00:00:00 2001 From: Daniel Veihelmann Date: Mon, 27 Nov 2017 16:53:58 +0100 Subject: [PATCH] Updated README to include Unix-separator hint --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 15415518..975d5f91 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,9 @@ $ clutz path/to/my/source1.js path/to/my/source2.js ... -o out.d.ts ``` -This creates TypeScript type definitions in `out.d.ts` for all the closure types discovered in the inputs. +When **running on Windows**, note that you have to use **Unix-style path separators** for the file paths (`/` instead of `\`). + +The example above creates TypeScript type definitions in `out.d.ts` for all the closure types discovered in the inputs. Symbols which were declared with `goog.provide('x')` may be imported in TypeScript as `import x from 'goog:x';`. For full explanation of what TypeScript types are produced for different Closure usages, see the `.js` and `.d.ts` files in `src/test/com/google/javascript/clutz`.