Skip to content

Commit 797181c

Browse files
committed
dcumentation
1 parent 2294611 commit 797181c

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

Diff for: scripts-sample.ts renamed to README.md

+15
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
## Instrucions
2+
* Download the executable or the main.go and add a scripts.ts file in the same directory.
3+
* Run the program with the following potential flags: `typescript2javascript.exe -minify`
4+
```
5+
-file string
6+
Path to the TypeScript file. (default "scripts.ts")
7+
-minify
8+
Minify the JavaScript output.
9+
-stream int
10+
File streaming minimum threshold in megabytes. (default 10)
11+
```
12+
13+
## Sample TypeScript content
14+
```typescript
115
// Define an interface for a Person
216
interface Person {
317
firstName: string;
@@ -39,3 +53,4 @@ console.log(student.greet());
3953

4054
// Call the getStudentId method
4155
console.log(`My student ID is ${student.getStudentId()}.`);
56+
```

0 commit comments

Comments
 (0)