Skip to content

Commit 133067a

Browse files
committed
docs: Move HIR Builder to Frontend Integrations with better description
- Added HIR Builder API section under Frontend Integrations - Described use cases: code generators, DSLs, compiler backends, testing - Removed duplicate section from Quick Start - Added production-ready status badge
1 parent 5f92ae1 commit 133067a

1 file changed

Lines changed: 33 additions & 25 deletions

File tree

README.md

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -302,32 +302,13 @@ zyntax compile out/*.json -o myprogram --run
302302

303303
See [Haxe Integration Guide](./docs/HAXE_INTEGRATION.md) for details.
304304

305-
### 🔜 Other Integrations
306-
307-
- **Whirlwind** - Direct AST adapter (in progress)
308-
- **Custom JSON** - Generate TypedAST JSON directly from any toolchain
305+
### ✅ HIR Builder API - Programmatic Code Generation
309306

310-
---
311-
312-
## 🚀 Quick Start
313-
314-
```bash
315-
# Clone the repository
316-
git clone https://github.com/darmie/zyntax.git
317-
cd zyntax
318-
319-
# Run tests
320-
cargo test
321-
322-
# Run comprehensive end-to-end tests
323-
cargo test --test end_to_end_comprehensive
324-
cargo test --test end_to_end_simple
325-
326-
# Build the compiler
327-
cargo build --release
328-
```
329-
330-
### Hello World with HIR Builder
307+
Build HIR modules directly from Rust code. Perfect for:
308+
- **Code generators** that emit Zyntax IR from other tools
309+
- **DSL implementations** that construct code at runtime
310+
- **Compiler backends** for languages with existing parsers
311+
- **Testing and prototyping** new language features
331312

332313
```rust
333314
use zyntax_compiler::hir_builder::HirBuilder;
@@ -364,6 +345,33 @@ let result = unsafe {
364345
assert_eq!(result, 42);
365346
```
366347

348+
**Status:****Production-ready** - Full SSA-based IR construction with type system integration
349+
350+
### 🔜 Other Integrations
351+
352+
- **Whirlwind** - Direct AST adapter (in progress)
353+
- **Custom JSON** - Generate TypedAST JSON directly from any toolchain
354+
355+
---
356+
357+
## 🚀 Quick Start
358+
359+
```bash
360+
# Clone the repository
361+
git clone https://github.com/darmie/zyntax.git
362+
cd zyntax
363+
364+
# Run tests
365+
cargo test
366+
367+
# Run comprehensive end-to-end tests
368+
cargo test --test end_to_end_comprehensive
369+
cargo test --test end_to_end_simple
370+
371+
# Build the compiler
372+
cargo build --release
373+
```
374+
367375
---
368376

369377
## 🏗️ Architecture

0 commit comments

Comments
 (0)