Skip to content

Commit 8334756

Browse files
committed
add a tsconfig.json, for use with the TypeScript sublime plugin and add instructions to the README
1 parent 65c8290 commit 8334756

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,23 @@ Having problems? To clean up from a partial, broken, or extremely out-dated buil
3030
./setup.sh clean
3131
```
3232

33+
## Developing
34+
35+
Sublime Text 3 provides a good development experience:
36+
37+
* Install [Sublime Text 3](http://www.sublimetext.com/3).
38+
* Install [Package Control](https://packagecontrol.io/).
39+
* Install the TypeScript package [home page](https://github.com/Microsoft/TypeScript-Sublime-Plugin).
40+
41+
Now, TypeScript files will have syntax highlighting and include support for "jump to definition" and refactoring (renaming).
42+
43+
Several compile errors will remain, namely imports from `../../../third_party`. To workaround, Unix (and OSX) users can create a symlink:
44+
45+
* `cd` to the directory containing the repo
46+
* `ln -s uproxy-lib/build/third_party ../third_party`
47+
48+
Re-compile, with F7 (and perhaps restart Sublime, just to be sure) to resolve these errors.
49+
3350
## Demo apps
3451

3552
After building, the apps can be found at `build/dev/uproxy-lib/samples/`. They

src/tsconfig.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"compilerOptions": {
3+
"module": "amd",
4+
"noEmit": true
5+
}
6+
}

0 commit comments

Comments
 (0)