Skip to content

Commit 01065e8

Browse files
ci: add missing INSTALLATION.md at repo root
Co-authored-by: Tcode-Motion <188012755+Tcode-Motion@users.noreply.github.com>
1 parent d985d49 commit 01065e8

1 file changed

Lines changed: 177 additions & 0 deletions

File tree

‎INSTALLATION.md‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
# Installing TechScript 2.0.0
2+
3+
TechScript is designed to install cleanly across desktop, server, and mobile developer environments with zero external runtime dependencies.
4+
5+
---
6+
7+
## 📋 System Requirements & Support Matrix
8+
9+
| Platform | Architecture | Binary Package | Status | Verification |
10+
| :--- | :--- | :--- | :--- | :--- |
11+
| **Windows 10/11** | `x86_64` | `techscript-2.0.0-windows-x86_64.zip` | Supported | Verified Native CI |
12+
| **Linux (glibc 2.31+)** | `x86_64` | `techscript-2.0.0-linux-x86_64.tar.gz` | Supported | Verified Native CI |
13+
| **Linux (ARM64)** | `aarch64` | `techscript-2.0.0-linux-aarch64.tar.gz` | Supported | Cross-Compiled & Tested |
14+
| **macOS (Apple Silicon)**| `aarch64` | `techscript-2.0.0-macos-aarch64.tar.gz` | Supported | Verified Native CI |
15+
| **macOS (Intel)** | `x86_64` | `techscript-2.0.0-macos-x86_64.tar.gz` | Supported | Verified Native CI |
16+
| **Android Termux** | `aarch64` | `techscript-2.0.0-termux-aarch64.tar.gz` | Supported | Verified on Termux aarch64 |
17+
18+
---
19+
20+
## 🪟 Windows Installation
21+
22+
### Option 1: Pre-built Archive (Recommended)
23+
24+
1. Download [`techscript-2.0.0-windows-x86_64.zip`](https://github.com/Tcode-Motion/techscript/releases/download/v2.0.0/techscript-2.0.0-windows-x86_64.zip).
25+
2. Extract the archive into a permanent folder (e.g. `C:\Program Files\TechScript` or `%LOCALAPPDATA%\TechScript`).
26+
3. Add the extracted directory to your system `PATH`:
27+
- Open PowerShell as Administrator:
28+
```powershell
29+
[Environment]::SetEnvironmentVariable("Path", $env:Path + ";$env:LOCALAPPDATA\TechScript", [EnvironmentVariableTarget]::User)
30+
```
31+
4. Open a fresh terminal and verify:
32+
```powershell
33+
techscript version
34+
webforge version
35+
```
36+
37+
### Option 2: Build from Source with Cargo
38+
39+
Prerequisites: Rust 1.80+ and MSVC Build Tools.
40+
```powershell
41+
git clone https://github.com/Tcode-Motion/techscript.git
42+
cd techscript
43+
cargo build --release --workspace
44+
# Binaries are placed in target\release\ (techscript.exe, webforge.exe, tsc.exe, tech.exe)
45+
```
46+
47+
---
48+
49+
## 🐧 Linux Installation
50+
51+
### Option 1: Automated Shell Installer
52+
53+
Run the universal installer script:
54+
```bash
55+
curl -fsSL https://raw.githubusercontent.com/Tcode-Motion/techscript/main/scripts/install.sh | bash
56+
```
57+
58+
### Option 2: Manual Tarball Installation
59+
60+
```bash
61+
# For x86_64:
62+
curl -LO https://github.com/Tcode-Motion/techscript/releases/download/v2.0.0/techscript-2.0.0-linux-x86_64.tar.gz
63+
tar -xzf techscript-2.0.0-linux-x86_64.tar.gz
64+
sudo install -m 755 techscript /usr/local/bin/
65+
sudo install -m 755 webforge /usr/local/bin/
66+
sudo install -m 755 tsc /usr/local/bin/
67+
sudo install -m 755 tech /usr/local/bin/
68+
69+
# Verify
70+
techscript version
71+
```
72+
73+
---
74+
75+
## 🍎 macOS Installation
76+
77+
### Option 1: Manual Tarball Installation
78+
79+
Download the archive matching your Mac's hardware:
80+
- **Apple Silicon (M1/M2/M3/M4):**
81+
```bash
82+
curl -LO https://github.com/Tcode-Motion/techscript/releases/download/v2.0.0/techscript-2.0.0-macos-aarch64.tar.gz
83+
tar -xzf techscript-2.0.0-macos-aarch64.tar.gz
84+
sudo install -m 755 techscript /usr/local/bin/
85+
sudo install -m 755 webforge /usr/local/bin/
86+
sudo install -m 755 tsc /usr/local/bin/
87+
sudo install -m 755 tech /usr/local/bin/
88+
```
89+
90+
- **Intel:**
91+
```bash
92+
curl -LO https://github.com/Tcode-Motion/techscript/releases/download/v2.0.0/techscript-2.0.0-macos-x86_64.tar.gz
93+
tar -xzf techscript-2.0.0-macos-x86_64.tar.gz
94+
sudo install -m 755 techscript /usr/local/bin/
95+
sudo install -m 755 webforge /usr/local/bin/
96+
sudo install -m 755 tsc /usr/local/bin/
97+
sudo install -m 755 tech /usr/local/bin/
98+
```
99+
100+
> [!NOTE]
101+
> **macOS Gatekeeper**: Unsigned development binaries can be authorized by removing the quarantine attribute:
102+
> ```bash
103+
> xattr -d com.apple.quarantine /usr/local/bin/techscript
104+
> xattr -d com.apple.quarantine /usr/local/bin/webforge
105+
> ```
106+
107+
---
108+
109+
## 📱 Android Termux Installation
110+
111+
TechScript provides first-class support for 64-bit ARM Android devices running inside Termux.
112+
113+
### Prerequisites
114+
115+
Open Termux and install system build essentials:
116+
```bash
117+
pkg update && pkg upgrade -y
118+
pkg install -y git rust clang binutils openssl
119+
```
120+
121+
### Option 1: Direct Termux Package
122+
123+
```bash
124+
curl -LO https://github.com/Tcode-Motion/techscript/releases/download/v2.0.0/techscript-2.0.0-termux-aarch64.tar.gz
125+
tar -xzf techscript-2.0.0-termux-aarch64.tar.gz -C $PREFIX/bin/
126+
chmod +x $PREFIX/bin/techscript $PREFIX/bin/webforge $PREFIX/bin/tsc $PREFIX/bin/tech
127+
128+
# Verify
129+
techscript version
130+
```
131+
132+
### Option 2: Compiling inside Termux
133+
134+
```bash
135+
git clone https://github.com/Tcode-Motion/techscript.git
136+
cd techscript
137+
cargo build --release -p techscript_cli
138+
cp target/release/techscript target/release/webforge $PREFIX/bin/
139+
```
140+
141+
---
142+
143+
## 🧪 Post-Installation Smoke Test
144+
145+
1. Verify the toolchain versions:
146+
```bash
147+
techscript version
148+
webforge version
149+
```
150+
*Expected output: `TechScript 2.0.0` and `WebForge 2.0.0`.*
151+
152+
2. Create and run a new TechScript project:
153+
```bash
154+
techscript new my_project
155+
cd my_project
156+
techscript run src/main.txs
157+
```
158+
159+
3. Launch a full-stack WebForge application:
160+
```bash
161+
webforge dev
162+
```
163+
*Visit `http://localhost:3000` in your web browser to test real-time hot reloading, 3D WebGL rendering, and SQLite persistence.*
164+
165+
---
166+
167+
## 🛠️ Uninstallation
168+
169+
- **Windows**: Delete the extracted directory and remove it from your User `PATH` environment variable.
170+
- **Linux / macOS**:
171+
```bash
172+
sudo rm -f /usr/local/bin/techscript /usr/local/bin/webforge /usr/local/bin/tsc /usr/local/bin/tech
173+
```
174+
- **Android Termux**:
175+
```bash
176+
rm -f $PREFIX/bin/techscript $PREFIX/bin/webforge $PREFIX/bin/tsc $PREFIX/bin/tech
177+
```

0 commit comments

Comments
 (0)