Skip to content

Commit b7d525d

Browse files
committed
Update README.md
Update the building and usage instructions
1 parent 585d9bd commit b7d525d

File tree

1 file changed

+43
-23
lines changed

1 file changed

+43
-23
lines changed

README.md

Lines changed: 43 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,6 @@
22

33
[TypeScript](http://www.typescriptlang.org/) is a language for application-scale JavaScript. TypeScript adds optional types, classes, and modules to JavaScript. TypeScript supports tools for large-scale JavaScript applications for any browser, for any host, on any OS. TypeScript compiles to readable, standards-based JavaScript. Try it out at the [playground](http://www.typescriptlang.org/Playground), and stay up to date via [our blog](http://blogs.msdn.com/typescript) and [twitter account](https://twitter.com/typescriptlang).
44

5-
## Installation
6-
7-
```shell
8-
npm install -g typescript
9-
```
10-
11-
## Usage
12-
13-
```shell
14-
tsc hello.ts
15-
```
165

176
## Contribute
187

@@ -34,18 +23,49 @@ There are many ways to [contribute](https://github.com/Microsoft/TypeScript/blob
3423

3524
## Building
3625

37-
1. Install [node](http://nodejs.org/) if you haven't already
38-
2. Install dependencies ([Jake](https://github.com/mde/jake), [mocha](http://visionmedia.github.io/mocha/), [Chai](http://chaijs.com/) and [browserify](http://browserify.org/) the tool we use to build our compiler. To do this, run `npm install`.
39-
3. To use jake, run one of the following commands:
40-
- jake local - This builds the compiler. The output is in built/local in the public directory
41-
- jake clean - deletes the build compiler
42-
- jake LKG - This replaces the LKG (last known good) version of the compiler with the built one.
43-
- This is a bootstrapping step to be executed whenever the built compiler reaches a stable state.
44-
- jake tests - This builds the test infrastructure, using the built compiler.
45-
- jake runtests - This runs the tests, using the built compiler and built test infrastructure.
46-
- You can also override the host or specify a test for this command. Use host=<hostName> or tests=<testPath>.
47-
- jake baseline-accept - This replaces the baseline test results with the results obtained from jake runtests.
48-
- jake -T lists the above commands.
26+
In order to build the TypeScript compiler, ensure that you have [Git](http://git-scm.com/downloads) and [Node.js]((http://nodejs.org/) installed.
27+
28+
Clone a copy of the repo:
29+
30+
```
31+
git clone https://github.com/Microsoft/TypeScript.git
32+
```
33+
34+
Change to the TypeScript directory:
35+
36+
```
37+
cd TypeScript
38+
```
39+
40+
Install Jake tools and dev dependencies:
41+
42+
```
43+
npm install -g jake
44+
npm install
45+
```
46+
47+
Use one of the following to build and test:
48+
49+
```
50+
jake local # Build the compiler into built/local
51+
jake clean # Delete the built compiler
52+
jake LKG # Replace the last known good with the built one.
53+
# Bootstrapping step to be executed when the built compiler reaches a stable state.
54+
jake tests # Build the test infrastructure using the built compiler.
55+
jake runtests # Run tests using the built compiler and test infrastructure.
56+
# You can override the host or specify a test for this command.
57+
# Use host=<hostName> or tests=<testPath>.
58+
jake baseline-accept # This replaces the baseline test results with the results obtained from jake runtests.
59+
jake -T # List the above commands.
60+
```
61+
62+
63+
## Usage
64+
65+
```shell
66+
node built/local/tc.js hello.ts
67+
```
68+
4969

5070
## Roadmap
5171

0 commit comments

Comments
 (0)