https://github.com/ironsheep/pnut-ts
Reimplementation of "PNut for Windows" in typescript
https://github.com/ironsheep/pnut-ts
parallax-multicore-microcontroller parallax-propeller-microcontroller pasm pasm2 propeller propeller2 spin spin2
Last synced: 24 days ago
JSON representation
Reimplementation of "PNut for Windows" in typescript
- Host: GitHub
- URL: https://github.com/ironsheep/pnut-ts
- Owner: ironsheep
- License: mit
- Created: 2024-01-02T23:45:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-05-05T20:38:06.000Z (27 days ago)
- Last Synced: 2026-05-05T22:29:43.399Z (27 days ago)
- Topics: parallax-multicore-microcontroller, parallax-propeller-microcontroller, pasm, pasm2, propeller, propeller2, spin, spin2
- Language: HTML
- Homepage:
- Size: 25.7 MB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: DOCs/README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Roadmap: DOCs/roadmaps/Architectural-Extraction-Roadmap.md
- Authors: AUTHORS
- Copyright: copyright
Awesome Lists containing this project
README
# PNut-TS Documentation
This directory contains comprehensive documentation for the PNut-TS SPIN2/PASM2 compiler.
## 📁 Directory Structure
### `/internals/` - Current System Documentation
Documents that explain how the existing compiler works:
- **[SPIN2-BIN-Format.md](internals/SPIN2-BIN-Format.md)** - Complete specification of the .bin file format and object organization
- **[Theory-of-Operations.md](internals/Theory-of-Operations.md)** - Comprehensive compilation flow from source files to binary output
- **[Distiller-Theory-of-Operations.md](internals/Distiller-Theory-of-Operations.md)** - How the object distillation mechanism works
### `/language-specification/` - PASM2/SPIN2 Language Specification Package
Complete language specification and IDE integration package for Parallax Propeller 2 development:
- **[README.md](language-specification/README.md)** - Complete language specification package overview
- **234 total language elements** extracted from PNut-TS compiler source
- **IDE integration files** for VS Code, Sublime, Atom, Vim, Emacs
- **Automated extraction pipeline** for maintaining sync with compiler changes
### `/roadmaps/` - Future Improvement Plans
Strategic plans for architectural improvements and optimizations:
- **[Architectural-Extraction-Roadmap.md](roadmaps/Architectural-Extraction-Roadmap.md)** - 9 major class extraction opportunities (180-280 hours)
- **[Performance-Analysis-and-Optimization-Roadmap.md](roadmaps/Performance-Analysis-and-Optimization-Roadmap.md)** - Comprehensive performance optimization strategy (180-350 hours)
- **[Distiller-Extraction-Roadmap.md](roadmaps/Distiller-Extraction-Roadmap.md)** - Plan to complete distiller class extraction (44-64 hours)
- **[Early-Deduplication-Fix-Plan.md](roadmaps/Early-Deduplication-Fix-Plan.md)** - Fix for the disabled early deduplication pass (30-44 hours)
## 🎯 Usage Guide
**Understanding the Current System:**
→ Start with `/internals/` documents to learn how the compiler works
**Planning Improvements:**
→ Review `/roadmaps/` documents for organized improvement opportunities
**Total Improvement Effort:** ~600+ hours across all roadmaps
**Expected Benefits:** 60%+ compilation speed improvement, 50%+ memory reduction, significantly improved maintainability