|
10 | 10 |
|
11 | 11 | --- |
12 | 12 |
|
| 13 | +## Quick Start |
| 14 | + |
| 15 | +New to Zyntax? **Read [The Zyn Book](https://github.com/darmie/zyntax/wiki)** - a comprehensive guide covering everything from basic grammar syntax to building complete DSLs with runtime plugins. |
| 16 | + |
| 17 | +```bash |
| 18 | +# Build zyntax |
| 19 | +cargo build --release |
| 20 | + |
| 21 | +# Compile and run a Zig file using the zig.zyn grammar |
| 22 | +./target/release/zyntax compile \ |
| 23 | + --grammar crates/zyn_peg/grammars/zig.zyn \ |
| 24 | + --source examples/hello.zig \ |
| 25 | + --run |
| 26 | + |
| 27 | +# Start an interactive REPL |
| 28 | +./target/release/zyntax repl --grammar crates/zyn_peg/grammars/zig.zyn |
| 29 | +``` |
| 30 | + |
| 31 | +--- |
| 32 | + |
13 | 33 | ## 🎯 What is Zyntax? |
14 | 34 |
|
15 | 35 | **Zyntax is a complete compiler infrastructure and runtime framework** designed for building high-performance, memory-safe programming languages. It provides: |
@@ -403,22 +423,22 @@ See [Embedding SDK Documentation](./book/12-embedding-sdk.md) for complete guide |
403 | 423 |
|
404 | 424 | --- |
405 | 425 |
|
406 | | -## 🚀 Quick Start |
| 426 | +## 🚀 Development Setup |
407 | 427 |
|
408 | 428 | ```bash |
409 | 429 | # Clone the repository |
410 | 430 | git clone https://github.com/darmie/zyntax.git |
411 | 431 | cd zyntax |
412 | 432 |
|
| 433 | +# Build the compiler |
| 434 | +cargo build --release |
| 435 | + |
413 | 436 | # Run tests |
414 | 437 | cargo test |
415 | 438 |
|
416 | 439 | # Run comprehensive end-to-end tests |
417 | 440 | cargo test --test end_to_end_comprehensive |
418 | 441 | cargo test --test end_to_end_simple |
419 | | - |
420 | | -# Build the compiler |
421 | | -cargo build --release |
422 | 442 | ``` |
423 | 443 |
|
424 | 444 | --- |
@@ -536,6 +556,28 @@ cargo build --release |
536 | 556 |
|
537 | 557 | ## 📚 Documentation |
538 | 558 |
|
| 559 | +### The Zyn Book |
| 560 | + |
| 561 | +**[The Zyn Book](https://github.com/darmie/zyntax/wiki)** is the comprehensive guide to Zyntax: |
| 562 | + |
| 563 | +1. [Introduction](https://github.com/darmie/zyntax/wiki/01-Introduction) - What is Zyn and why use it? |
| 564 | +2. [Getting Started](https://github.com/darmie/zyntax/wiki/02-Getting-Started) - Your first Zyn grammar |
| 565 | +3. [Using the CLI](https://github.com/darmie/zyntax/wiki/03-Using-the-CLI) - Compilation, execution, and REPL |
| 566 | +4. [Grammar Syntax](https://github.com/darmie/zyntax/wiki/04-Grammar-Syntax) - PEG-based grammar rules |
| 567 | +5. [Semantic Actions](https://github.com/darmie/zyntax/wiki/05-Semantic-Actions) - JSON command blocks |
| 568 | +6. [The TypedAST](https://github.com/darmie/zyntax/wiki/06-The-TypedAST) - Understanding the target representation |
| 569 | +7. [TypedAST Builder](https://github.com/darmie/zyntax/wiki/07-TypedAST-Builder) - Building AST nodes programmatically |
| 570 | +8. [Complete Example: Zig](https://github.com/darmie/zyntax/wiki/08-Zig-Example) - A real-world grammar walkthrough |
| 571 | +9. [Reference](https://github.com/darmie/zyntax/wiki/09-Reference) - Command reference and API |
| 572 | +10. [Packaging & Distribution](https://github.com/darmie/zyntax/wiki/10-Packaging-Distribution) - ZPack format, AOT linking |
| 573 | +11. [HIR Builder](https://github.com/darmie/zyntax/wiki/11-HIR-Builder) - Building HIR directly for custom backends |
| 574 | +12. [Embedding SDK](https://github.com/darmie/zyntax/wiki/12-Embedding-SDK) - Embedding Zyntax in Rust applications |
| 575 | +13. [Async Runtime](https://github.com/darmie/zyntax/wiki/13-Async-Runtime) - Promise-based async native runtime |
| 576 | +14. [Runtime Plugins](https://github.com/darmie/zyntax/wiki/14-Runtime-Plugins) - ZRTL standard library plugins |
| 577 | +15. [Building DSLs](https://github.com/darmie/zyntax/wiki/15-Building-DSLs) - Creating domain-specific languages |
| 578 | + |
| 579 | +### Technical Documentation |
| 580 | + |
539 | 581 | - **[Architecture Guide](docs/ARCHITECTURE.md)** - Complete system architecture |
540 | 582 | - **[HIR Builder Example](docs/HIR_BUILDER_EXAMPLE.md)** - How to construct HIR programmatically |
541 | 583 | - **[Async Runtime Design](docs/ASYNC_RUNTIME_DESIGN.md)** - Async/await internals |
|
0 commit comments