Skip to content

Commit b3cdaae

Browse files
committed
docs(readme): move installation before quick start and rewrite quick start to show explicit hello.txs creation and execution
1 parent 7a0697e commit b3cdaae

1 file changed

Lines changed: 24 additions & 18 deletions

File tree

README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@
3232
3. [Key Differentiators](#-key-differentiators)
3333
4. [Syntax at a Glance](#-syntax-at-a-glance)
3434
5. [Architecture Design](#-architecture-design)
35-
6. [Quick Start](#-quick-start)
36-
7. [Installation](#-installation)
35+
6. [Installation](#-installation)
36+
7. [Quick Start](#-quick-start)
3737
8. [Language Guide](#-language-guide)
3838
9. [Standard Library & Modules](#-standard-library--modules)
3939
10. [CLI Commands](#-cli-commands)
@@ -113,22 +113,6 @@ graph TD
113113

114114
---
115115

116-
## 🚀 Quick Start
117-
118-
Once TechScript is installed on your system, you can scaffold and execute a new project in under 10 seconds:
119-
120-
1. **Scaffold a Project**:
121-
```bash
122-
tsc new hello_world
123-
cd hello_world
124-
```
125-
2. **Compile and Run**:
126-
```bash
127-
tsc run
128-
```
129-
130-
---
131-
132116
## 📦 Installation
133117

134118
### 1. 🪟 Windows Setup
@@ -171,6 +155,28 @@ The PyPI package auto-detects your OS/architecture and downloads the correct nat
171155
172156
---
173157

158+
## 🚀 Quick Start
159+
160+
Once TechScript is installed, you can write and execute your first script in under 10 seconds:
161+
162+
1. **Create and Enter a Project Directory**:
163+
```bash
164+
mkdir hello_world
165+
cd hello_world
166+
```
167+
2. **Create a Script File**:
168+
Create a new file named `hello.txs` and add:
169+
```txs
170+
say "Hello, World! 🌍"
171+
```
172+
3. **Compile and Run**:
173+
Run the file using the `tsc` compiler driver:
174+
```bash
175+
tsc run hello.txs
176+
```
177+
178+
---
179+
174180
## 📘 Language Guide
175181

176182
TechScript's syntax builds from simple assignments to full structured programs:

0 commit comments

Comments
 (0)