Go to file

Mohamed Hegazy b7d525d394 Update README.md Update the building and usage instructions		2014-07-21 10:38:22 -07:00
bin	Update tsc	2014-07-16 16:06:45 -07:00
doc	Add snapshot of compiler sources	2014-07-12 17:30:19 -07:00
scripts	Add snapshot of compiler sources	2014-07-12 17:30:19 -07:00
src	Condense all error spans to just the name for variable, class, interface, module, enum and enum member	2014-07-21 09:55:43 -07:00
tests	Condense all error spans to just the name for variable, class, interface, module, enum and enum member	2014-07-21 09:55:43 -07:00
.gitignore	Cleanup temporary project output after running tests	2014-07-17 12:32:51 -07:00
.npmignore	Update .npmignore	2014-07-16 15:57:55 -07:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2014-07-16 12:46:52 -07:00
CopyrightNotice.txt	Add snapshot of compiler sources	2014-07-12 17:30:19 -07:00
Jakefile	Merge pull request #38 from Microsoft/projectBaselines	2014-07-17 17:33:36 -07:00
LICENSE.txt	Add snapshot of compiler sources	2014-07-12 17:30:19 -07:00
package.json	Update package.json	2014-07-16 16:06:03 -07:00
README.md	Update README.md	2014-07-21 10:38:22 -07:00
ThirdPartyNoticeText.txt	Add snapshot of compiler sources	2014-07-12 17:30:19 -07:00

README.md

TypeScript

TypeScript 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, and stay up to date via our blog and twitter account.

Contribute

There are many ways to contribute to TypeScript.

Submit bugs and help us verify fixes as they are checked in.
Review the source code changes.
Engage with other TypeScript users and developers on StackOverflow.
Join the #typescript discussion on Twitter.
Contribute bug fixes.
Read the language specification (docx, pdf).

Documentation

Building

In order to build the TypeScript compiler, ensure that you have Git and [Node.js]((http://nodejs.org/) installed.

Clone a copy of the repo:

git clone https://github.com/Microsoft/TypeScript.git

Change to the TypeScript directory:

cd TypeScript

Install Jake tools and dev dependencies:

npm install -g jake
npm install

Use one of the following to build and test:

jake local           # Build the compiler into built/local 
jake clean           # Delete the built compiler 
jake LKG             # Replace the last known good with the built one.
                     # Bootstrapping step to be executed when the built compiler reaches a stable state.
jake tests           # Build the test infrastructure using the built compiler. 
jake runtests        # Run tests using the built compiler and test infrastructure. 
                     # You can override the host or specify a test for this command. 
                     # Use host=<hostName> or tests=<testPath>. 
jake baseline-accept # This replaces the baseline test results with the results obtained from jake runtests. 
jake -T              # List the above commands.

Usage

node built/local/tc.js hello.ts

Roadmap

For details on our planned features and future direction please refer to our roadmap.