Skip to content

Commit c811e8c

Browse files
committed
docs: improve readme with usage guide and features
1 parent 9d9e057 commit c811e8c

1 file changed

Lines changed: 50 additions & 18 deletions

File tree

README.md

Lines changed: 50 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,59 @@
11
# TechScript
22

3-
TechScript is a simple, friendly programming language (.txs).
3+
![TechScript Logo](assets/icons/icon-128.png)
4+
5+
TechScript (`.txs`) is a modern, statically-analyzable scripting language that aims to be simple, friendly, and powerful. It is built to offer a clean syntax that compiles directly to Python or evaluates on the fly.
6+
7+
## Why TechScript? What makes it better?
8+
9+
- **Zero Setup Complexity**: No heavy runtime environments to install. Download, run `setup.bat`, and you are writing code in seconds.
10+
- **Python Ecosystem Power**: TechScript can transpile your `.txs` files directly into valid Python code, allowing you to gradually adopt it or use it as a powerful front-end for Python.
11+
- **Friendly Syntax**: Designed to be intuitive for beginners while offering the robustness needed for serious scripting.
12+
- **Built-in Tooling**: The single `tech` binary includes an interpreter, transpiler, syntax checker, and an interactive REPL out of the box.
413

514
## Installation
615

7-
### Windows
8-
Double-click `setup.bat` to install. This will:
9-
1. Copy `tech.exe` to an isolated `.techscript/bin` user directory.
10-
2. Add the command to your `PATH`.
11-
3. Install the VS Code extension for `.txs` files.
16+
### Windows (Recommended)
17+
1. Download this repository.
18+
2. Double-click `setup.bat` to install. This will:
19+
- Copy `tech.exe` to a safe `.techscript/bin` user directory.
20+
- Automatically add the command to your `PATH`.
21+
- Install the official **VS Code extension**, providing syntax highlighting and file icons for `.txs` files.
22+
3. Restart your terminal or command prompt!
23+
24+
### Manual Installation
25+
You can manually place the `bin/tech.exe` file anywhere in your system's `PATH`. *(Note: You will need to install the VS Code extension manually from the `vscode-extension` folder if you choose this route).*
26+
27+
## Usage Guide
28+
29+
TechScript is designed to be straightforward from the command line. Use the `tech` command to interact with your code.
30+
31+
### 1. Run a script
32+
Execute a script directly using the built-in interpreter:
33+
```bash
34+
tech run file.txs
35+
```
36+
37+
### 2. Transpile to Python
38+
Convert your TechScript code into valid Python code. You can run it immediately or save the output:
39+
```bash
40+
tech transpile file.txs
41+
tech transpile file.txs -o output.py
42+
```
1243

13-
Alternatively, you can manually place `bin/tech.exe` anywhere in your system `PATH`.
44+
### 3. Syntax Checking
45+
Validate your code for errors without actually running it:
46+
```bash
47+
tech check file.txs
48+
```
1449

15-
## Features
16-
- Interpretable `.txs` source files
17-
- Simple syntax
18-
- Included `tech check` and interactive `tech repl`
19-
- Syntax checking and transpiling capabilities.
50+
### 4. Interactive Console (REPL)
51+
Start the interactive TechScript prompt to test out commands line-by-line:
52+
```bash
53+
tech repl
54+
```
2055

21-
## Usage
22-
- Run a script: `tech run file.txs`
23-
- Transpile to python: `tech transpile file.txs`
24-
- Syntax check only: `tech check file.txs`
25-
- Start interactive prompt: `tech repl`
56+
## Documentation & Learning
2657

27-
Check the `examples/` directory for syntax basics!
58+
- **[Language Documentation](docs/)**: Explore the `docs/` folder for a deep dive into the language features, standard library, and architecture.
59+
- **[Examples](examples/)**: Check out the `examples/` directory for ready-to-use snippets demonstrating loops, functions, variables, and more basics to get you started quickly!

0 commit comments

Comments
 (0)