Skip to content

Commit

Permalink
Add more to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Codesleuth committed Aug 29, 2015
1 parent 043e114 commit 4f64aab
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
vscode-typescript-example
=========================

This project demonstrates a skeleton structure and necessary settings files to allow TypeScript development in [Visual Studio Code][vscode] (as of build 0.7.10). The project builds all TypeScript (`.ts`) files into a `build/js` directory in the root.
This project provides a skeleton structure and IDE settings files to help with TypeScript development in [Visual Studio Code][vscode] (as of build 0.7.10). The project builds all TypeScript (`.ts`) files into a `build/js` directory in the root.

## Project Structure
The project currently provides the following features:
Expand Down Expand Up @@ -49,13 +49,13 @@ This repository is ready for you to clone and start building your code around it
$ npm install tsd -g
```
4. Run `tsd` to install the required module type definitions defined in `tsd.json`:
4. Run `tsd install` to fetch the required module type definitions defined in `tsd.json`:
```bash
# if installed globally (recommended)
$ tsd install
# otherwise
$ ./node_modules/.bin/tsd
$ ./node_modules/.bin/tsd install
```
### Building
Expand All @@ -77,7 +77,7 @@ build/
app.js.map
```
## Error Navigation
### Error Navigation
After building or testing, errors are captured (defined in the `.settings/tasks.json` file) and can be viewed with <kbd>CTRL</kbd>/<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>M</kbd>.
Your `.ts` files have been compiled to `.js` files within the `build` directory, and each should have a `.js.map` _sourcemap_ file alongside it to allow stack traces to correctly report the line in the original file. See [this StackOverflow article][sourcemapquestion] for an overview of what a sourcemap is.
Expand All @@ -88,7 +88,10 @@ There's a sample test located in the `test` folder. You can run them by hitting
### Running and Debugging
To run the project in debug mode, simply hit <kbd>F5</kbd>! Place breakpoints in your TypeScript code and view them in the debugger (<kbd>CTRL</kbd>+<kbd>Shift</kbd>+<kbd>D</kbd> or <kbd>Cmd</kbd>+<kbd>Shift</kbd>+<kbd>D</kbd>).

### License
## Contribute
Yes, that would be great! Open a pull request and we'll go from there!
## License
MIT
[vscode]: https://code.visualstudio.com/
Expand Down

0 comments on commit 4f64aab

Please sign in to comment.