commit 99ec3a96880649eeaa08c3df30e3ae802048f4fe Author: Mohamed Hegazy Date: Mon Jul 7 17:08:16 2014 -0700 Initial commit diff --git a/README.md b/README.md new file mode 100644 index 0000000000..7e571e5d91 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# TypeScript + +Scalable JavaScript development with types, classes and modules. + +## Install + + npm install -g typescript + +## Usage + + tsc hello.ts + + +## Build + +1. Install Node if you haven't already (http://nodejs.org/) +2. Install Jake, the tool we use to build our compiler (https://github.com/mde/jake). To do this, run "npm install -g jake". +3. To use jake, run one of the following commands: + - jake local - This builds the compiler. The output is in built/local in the public directory + - jake clean - deletes the build compiler + - jake LKG - This replaces the LKG (last known good) version of the compiler with the built one. + - This is a bootstrapping step to be executed whenever the built compiler reaches a stable state. + - jake tests - This builds the test infrastructure, using the built compiler. + - jake runtests - This runs the tests, using the built compiler and built test infrastructure. + - You can also override the host or specify a test for this command. Use host= or tests=. + - jake baseline-accept - This replaces the baseline test results with the results obtained from jake runtests. + - jake -T lists the above commands.