Skip to content
This repository was archived by the owner on Oct 12, 2022. It is now read-only.

Commit e9700be

Browse files
author
marcin
committed
Change all README.txt to README.md
1 parent 2c3fa1d commit e9700be

File tree

12 files changed

+193
-180
lines changed

12 files changed

+193
-180
lines changed

amd/README.txt renamed to amd/README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
===== TypeScript Sample: AMD Module =====
2-
3-
=== Overview ===
4-
This sample shows a simple Typescript application using an AMD module.
5-
6-
=== Running ===
7-
tsc --sourcemap --module amd app.ts
8-
start default.htm
9-
10-
1+
# TypeScript Sample: AMD Module
2+
3+
## Overview
4+
This sample shows a simple Typescript application using an AMD module.
5+
6+
## Running
7+
```
8+
tsc --sourcemap --module amd app.ts
9+
start default.htm
10+
```
11+

d3/README.txt renamed to d3/README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
===== TypeScript Sample: D3 =====
2-
3-
=== Overview ===
4-
5-
D3 visualization
6-
- Use of the D3 wrapper
7-
- Use of modules and interfaces
8-
9-
=== Running ===
10-
tsc --sourcemap data.ts
11-
start perf.html
1+
# TypeScript Sample: D3
2+
3+
## Overview
4+
5+
D3 visualization
6+
- Use of the D3 wrapper
7+
- Use of modules and interfaces
8+
9+
## Running
10+
```
11+
tsc --sourcemap data.ts
12+
start perf.html
13+
```

greeter/README.txt renamed to greeter/README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
===== TypeScript Sample: Greeter =====
2-
3-
=== Overview ===
4-
5-
This sample shows basic class definition and instantiation.
6-
7-
=== Running ===
8-
tsc --sourcemap greeter.ts
9-
start greeter.html
1+
# TypeScript Sample: Greeter
2+
3+
## Overview
4+
5+
This sample shows basic class definition and instantiation.
6+
7+
## Running
8+
```
9+
tsc --sourcemap greeter.ts
10+
start greeter.html
11+
```

imageboard/README.txt renamed to imageboard/README.md

Lines changed: 35 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,35 @@
1-
===== TypeScript Sample: Image Board =====
2-
3-
=== Overview ===
4-
5-
This sample implements a complete Node.js application.
6-
Notable features:
7-
- Typed usage of express for server side MVC
8-
- Typed usage of mongodb for server side database
9-
- Typed usage of Node.js
10-
- Use of TypeScript module syntax
11-
- Visual Studio project file for working with the project
12-
13-
=== Running ===
14-
15-
Note: Perform steps 3 - 6 with your working directory set to the folder containing this README:
16-
17-
1. Install MongoDB if necessary (see http://docs.mongodb.org/manual/installation/ )
18-
19-
2. Run the following command to launch the MongoDB process:
20-
21-
<mongoinstalldir>\bin\mongod
22-
23-
3. Restore the sample app data to MongoDB in another command prompt with the following command:
24-
25-
<mongoinstalldir>\bin\mongorestore dump
26-
27-
4. Install the app's node dependencies with the following command:
28-
29-
npm install
30-
31-
5. Compile the app with the following command:
32-
33-
tsc --sourcemap --module commonjs app.ts
34-
35-
6. Launch the Node process to serve the app using the following command:
36-
37-
node app.js
38-
39-
7. Open your favorite browser and going to the following URL to access the app:
40-
41-
http://localhost:3000/
1+
# TypeScript Sample: Image Board
2+
3+
## Overview
4+
5+
This sample implements a complete Node.js application.
6+
Notable features:
7+
- Typed usage of express for server side MVC
8+
- Typed usage of mongodb for server side database
9+
- Typed usage of Node.js
10+
- Use of TypeScript module syntax
11+
- Visual Studio project file for working with the project
12+
13+
## Running
14+
15+
Note: Perform steps 3 - 6 with your working directory set to the folder containing this README:
16+
17+
1. Install MongoDB if necessary (see http://docs.mongodb.org/manual/installation/ )
18+
19+
2. Run the following command to launch the MongoDB process:
20+
`<mongoinstalldir>\bin\mongod`
21+
22+
3. Restore the sample app data to MongoDB in another command prompt with the following command:
23+
`<mongoinstalldir>\bin\mongorestore dump`
24+
25+
4. Install the app's node dependencies with the following command:
26+
`npm install`
27+
28+
5. Compile the app with the following command:
29+
`tsc --sourcemap --module commonjs app.ts`
30+
31+
6. Launch the Node process to serve the app using the following command:
32+
`node app.js`
33+
34+
7. Open your favorite browser and going to the following URL to access the app:
35+
`http://localhost:3000/`

interfaces/README.txt renamed to interfaces/README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
===== TypeScript Sample: Simple =====
2-
3-
=== Overview ===
4-
5-
Simple use of classes and inheritance:
6-
- Interface: A simple interface that defines the interface for something that can drive.
7-
- Class: An implementation of a car.
8-
9-
=== Keep Playing ===
10-
11-
Want to experiment? Try adding a second interface: Flyable. Implement it in a Helicopter class, then write a FlyingCar class that implements both Drivable and Flyable!
12-
13-
interface Flyable { ... }
14-
class Helicopter implements Flyable { ... }
15-
class FlyingCar implements Drivable, Flyable { ... }
16-
17-
=== Running ===
18-
tsc --sourcemap interfaces.ts
1+
# TypeScript Sample: Simple
2+
3+
## Overview
4+
5+
Simple use of classes and inheritance:
6+
- Interface: A simple interface that defines the interface for something that can drive.
7+
- Class: An implementation of a car.
8+
9+
## Keep Playing
10+
11+
Want to experiment? Try adding a second interface: Flyable. Implement it in a Helicopter class, then write a FlyingCar class that implements both Drivable and Flyable!
12+
```
13+
interface Flyable { ... }
14+
class Helicopter implements Flyable { ... }
15+
class FlyingCar implements Drivable, Flyable { ... }
16+
```
17+
## Running
18+
`tsc --sourcemap interfaces.ts`

jquery/README.txt renamed to jquery/README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
===== TypeScript Sample: JQuery Parallax Starfield =====
2-
3-
=== Overview ===
4-
5-
This sample shows a simple jQuery application in TypeScript using a jQuery TypeScript typing.
6-
7-
=== Usage ===
8-
9-
For best results, scroll the window using the scrollbar.
10-
11-
=== Running ===
12-
tsc --sourcemap --target ES5 parallax.ts
13-
start parallax.html
1+
# TypeScript Sample: JQuery Parallax Starfield
2+
3+
## Overview
4+
5+
This sample shows a simple jQuery application in TypeScript using a jQuery TypeScript typing.
6+
7+
## Usage
8+
9+
For best results, scroll the window using the scrollbar.
10+
11+
## Running
12+
```
13+
tsc --sourcemap --target ES5 parallax.ts
14+
start parallax.html
15+
```

mankala/README.txt renamed to mankala/README.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
===== TypeScript Sample: Mankala =====
2-
3-
=== Overview ===
4-
5-
This sample implements the game logic for the Mankala board game. The following
6-
features of TypeScript are highlighted:
7-
- Multi-file compilation: The sample is compiled from several separate files
8-
- SVG: Geometry
9-
- Class inheritance: Rectangle and Square in geometry.ts
10-
- Command line: The game driver can be run as a command-line app using cscript
11-
12-
13-
=== Running ===
14-
tsc Driver.ts --sourcemap -out game.js
15-
cscript game.js
16-
17-
For web execution use play.htm.
18-
1+
# TypeScript Sample: Mankala
2+
3+
## Overview
4+
5+
This sample implements the game logic for the Mankala board game. The following
6+
features of TypeScript are highlighted:
7+
- Multi-file compilation: The sample is compiled from several separate files
8+
- SVG: Geometry
9+
- Class inheritance: Rectangle and Square in geometry.ts
10+
- Command line: The game driver can be run as a command-line app using cscript
11+
12+
13+
## Running
14+
```
15+
tsc Driver.ts --sourcemap -out game.js
16+
cscript game.js
17+
```
18+
For web execution use play.htm.
19+

node/README.txt renamed to node/README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
===== TypeScript Sample: Node.js =====
2-
3-
=== Overview ===
4-
5-
This sample implements a very basic node.js application using TypeScript
6-
7-
=== Running ===
8-
For HttpServer
9-
tsc --sourcemap --module commonjs HttpServer.ts
10-
node HttpServer.js
11-
12-
For TcpServer
13-
tsc --sourcemap --module commonjs TcpServer.ts
14-
node TcpServer.js
1+
# TypeScript Sample: Node.js
2+
3+
## Overview
4+
5+
This sample implements a very basic node.js application using TypeScript
6+
7+
## Running
8+
For HttpServer
9+
```
10+
tsc --sourcemap --module commonjs HttpServer.ts
11+
node HttpServer.js
12+
```
13+
14+
For TcpServer
15+
```
16+
tsc --sourcemap --module commonjs TcpServer.ts
17+
node TcpServer.js
18+
```

raytracer/README.txt renamed to raytracer/README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
===== TypeScript Sample: Raytracer =====
2-
3-
=== Overview ===
4-
5-
This sample shows a raytracer implementation in TypeScript.
6-
7-
=== Running ===
8-
tsc --sourcemap raytracer.ts
9-
start raytracer.html
1+
# TypeScript Sample: Raytracer
2+
3+
## Overview
4+
5+
This sample shows a raytracer implementation in TypeScript.
6+
7+
## Running
8+
```
9+
tsc --sourcemap raytracer.ts
10+
start raytracer.html
11+
```

simple/README.txt renamed to simple/README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
===== TypeScript Sample: Simple =====
2-
3-
=== Overview ===
4-
5-
Simple use of classes and inheritance:
6-
- Classes: A base class and two subclasses
7-
- Super calls: Derived classes make super calls
8-
9-
10-
=== Running ===
11-
tsc --sourcemap animals.ts
1+
# TypeScript Sample: Simple
2+
3+
## Overview
4+
5+
Simple use of classes and inheritance:
6+
- Classes: A base class and two subclasses
7+
- Super calls: Derived classes make super calls
8+
9+
10+
## Running
11+
12+
`tsc --sourcemap animals.ts`

0 commit comments

Comments
 (0)