Skip to content

Commit 43f2e36

Browse files
author
Max Heiber
committed
WIP
1 parent 3f21444 commit 43f2e36

File tree

1 file changed

+1
-99
lines changed

1 file changed

+1
-99
lines changed

README.md

Lines changed: 1 addition & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1 @@
1-
[![Build Status](https://travis-ci.org/Microsoft/TypeScript.svg?branch=master)](https://travis-ci.org/Microsoft/TypeScript)
2-
[![VSTS Build Status](https://typescript.visualstudio.com/_apis/public/build/definitions/cf7ac146-d525-443c-b23c-0d58337efebc/4/badge)](https://typescript.visualstudio.com/TypeScript/_build/index?context=allDefinitions&path=%5C&definitionId=4&_a=completed)
3-
[![npm version](https://badge.fury.io/js/typescript.svg)](https://www.npmjs.com/package/typescript)
4-
[![Downloads](https://img.shields.io/npm/dm/typescript.svg)](https://www.npmjs.com/package/typescript)
5-
6-
# TypeScript
7-
8-
[![Join the chat at https://gitter.im/Microsoft/TypeScript](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Microsoft/TypeScript?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
9-
10-
[TypeScript](https://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](https://www.typescriptlang.org/play/), and stay up to date via [our blog](https://blogs.msdn.microsoft.com/typescript) and [Twitter account](https://twitter.com/typescriptlang).
11-
12-
## Installing
13-
14-
For the latest stable version:
15-
16-
```bash
17-
npm install -g typescript
18-
```
19-
20-
For our nightly builds:
21-
22-
```bash
23-
npm install -g typescript@next
24-
```
25-
26-
## Contribute
27-
28-
There are many ways to [contribute](https://github.com/Microsoft/TypeScript/blob/master/CONTRIBUTING.md) to TypeScript.
29-
* [Submit bugs](https://github.com/Microsoft/TypeScript/issues) and help us verify fixes as they are checked in.
30-
* Review the [source code changes](https://github.com/Microsoft/TypeScript/pulls).
31-
* Engage with other TypeScript users and developers on [StackOverflow](https://stackoverflow.com/questions/tagged/typescript).
32-
* Join the [#typescript](https://twitter.com/#!/search/realtime/%23typescript) discussion on Twitter.
33-
* [Contribute bug fixes](https://github.com/Microsoft/TypeScript/blob/master/CONTRIBUTING.md).
34-
* Read the language specification ([docx](https://github.com/Microsoft/TypeScript/blob/master/doc/TypeScript%20Language%20Specification.docx?raw=true),
35-
[pdf](https://github.com/Microsoft/TypeScript/blob/master/doc/TypeScript%20Language%20Specification.pdf?raw=true), [md](https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md)).
36-
37-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see
38-
the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected])
39-
with any additional questions or comments.
40-
41-
## Documentation
42-
43-
* [Quick tutorial](https://www.typescriptlang.org/docs/tutorial.html)
44-
* [Programming handbook](https://www.typescriptlang.org/docs/handbook/basic-types.html)
45-
* [Language specification](https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md)
46-
* [Homepage](https://www.typescriptlang.org/)
47-
48-
## Building
49-
50-
In order to build the TypeScript compiler, ensure that you have [Git](https://git-scm.com/downloads) and [Node.js](https://nodejs.org/) installed.
51-
52-
Clone a copy of the repo:
53-
54-
```bash
55-
git clone https://github.com/Microsoft/TypeScript.git
56-
```
57-
58-
Change to the TypeScript directory:
59-
60-
```bash
61-
cd TypeScript
62-
```
63-
64-
Install Jake tools and dev dependencies:
65-
66-
```bash
67-
npm install -g jake
68-
npm install
69-
```
70-
71-
Use one of the following to build and test:
72-
73-
```
74-
jake local # Build the compiler into built/local
75-
jake clean # Delete the built compiler
76-
jake LKG # Replace the last known good with the built one.
77-
# Bootstrapping step to be executed when the built compiler reaches a stable state.
78-
jake tests # Build the test infrastructure using the built compiler.
79-
jake runtests # Run tests using the built compiler and test infrastructure.
80-
# You can override the host or specify a test for this command.
81-
# Use host=<hostName> or tests=<testPath>.
82-
jake runtests-browser # Runs the tests using the built run.js file. Syntax is jake runtests. Optional
83-
parameters 'host=', 'tests=[regex], reporter=[list|spec|json|<more>]'.
84-
jake baseline-accept # This replaces the baseline test results with the results obtained from jake runtests.
85-
jake lint # Runs tslint on the TypeScript source.
86-
jake help # List the above commands.
87-
```
88-
89-
90-
## Usage
91-
92-
```bash
93-
node built/local/tsc.js hello.ts
94-
```
95-
96-
97-
## Roadmap
98-
99-
For details on our planned features and future direction please refer to our [roadmap](https://github.com/Microsoft/TypeScript/wiki/Roadmap).
1+

0 commit comments

Comments
 (0)