https://github.com/ironsheep/pnut-term-ts
A combination of the P2 downloader, PST and a recreation of Chips' Debug listener, all in typescript so is multiplatform
https://github.com/ironsheep/pnut-term-ts
debugging-tool developer-tools parallax-multicore-microcontroller parallax-propeller-microcontroller pasm2 propeller2 serial-communication spin2
Last synced: 5 days ago
JSON representation
A combination of the P2 downloader, PST and a recreation of Chips' Debug listener, all in typescript so is multiplatform
- Host: GitHub
- URL: https://github.com/ironsheep/pnut-term-ts
- Owner: ironsheep
- License: mit
- Created: 2024-12-02T22:53:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-06-12T06:41:29.000Z (7 days ago)
- Last Synced: 2026-06-12T08:23:06.471Z (7 days ago)
- Topics: debugging-tool, developer-tools, parallax-multicore-microcontroller, parallax-propeller-microcontroller, pasm2, propeller2, serial-communication, spin2
- Language: TypeScript
- Homepage:
- Size: 22.1 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: DOCs/README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Authors: AUTHORS
- Copyright: copyright
Awesome Lists containing this project
README
# PNut-Term-TS Documentation
This directory contains public-facing documentation for PNut-Term-TS, a cross-platform debug terminal for the Parallax Propeller 2 microcontroller.
## User Documentation
### Primary Guides
- **[QUICK-START.md](QUICK-START.md)** - Get up and running in 2 minutes
- **[USER-GUIDE.md](USER-GUIDE.md)** - Complete reference covering all features
- **[APP-HELP.md](APP-HELP.md)** - Built-in application help content (displayed in Help menu)
### Specialized Guides
- **[DEBUGGER-USER-MANUAL.md](DEBUGGER-USER-MANUAL.md)** - Detailed guide for using the debugger window
- **[PATH-SETUP-GUIDE.md](PATH-SETUP-GUIDE.md)** - Configuration guide for PNut compiler path setup
## Technical Documentation
### System Architecture
- **[IMPLEMENTATION_NOTES.md](IMPLEMENTATION_NOTES.md)** - Technical implementation details and architecture
- **[WINDOW-PLACEMENT-ALGORITHM.md](WINDOW-PLACEMENT-ALGORITHM.md)** - Algorithm documentation for debug window positioning
- **[REPOSITORY-ORGANIZATION.md](REPOSITORY-ORGANIZATION.md)** - Repository structure and organization guide
## Reference Materials
### Pascal Source References
The `pascal-REF/` directory contains theory of operations documentation derived from the original Pascal implementation:
- **theory-of-operations/** - Detailed operational specifications for each debug window type:
- `BITMAP_Theory_of_Operations.md` - Bitmap visualization window
- `FFT_Theory_of_Operations.md` - FFT spectrum analyzer window
- `LOGIC_Theory_of_Operations.md` - Logic analyzer window
- `MIDI_Theory_of_Operations.md` - MIDI interface window
- `PLOT_Theory_of_Operations.md` - Data plotting window
- `SCOPE_Theory_of_Operations.md` - Oscilloscope window
- `SCOPE_XY_Theory_of_Operations.md` - XY oscilloscope window
- `SINGLE_STEP_DEBUGGER_Theory_of_Operations.md` - Debugger window
- `SPECTRO_Theory_of_Operations.md` - Spectrogram window
- `TERM_Theory_of_Operations.md` - Terminal window
### Additional Resources
- **images/** - Application icons, logos, and visual assets
- **source/** - Source materials including font notes and layout files
- **archive/** - Previous versions of documentation for reference
## Documentation Purpose
This documentation serves multiple audiences:
1. **End Users** - Learn how to use PNut-Term-TS effectively
2. **Developers** - Understand the architecture and implementation details
3. **Contributors** - Reference materials for maintaining Pascal parity
## Quick Reference
### For New Users
Start with **[QUICK-START.md](QUICK-START.md)** to get running in minutes, then refer to **[USER-GUIDE.md](USER-GUIDE.md)** for detailed information on specific features.
### For Developers
Review **[IMPLEMENTATION_NOTES.md](IMPLEMENTATION_NOTES.md)** for architecture overview and the theory-of-operations documents for window-specific implementation details.
## Version Information
These documents are maintained alongside the codebase and reflect the current implementation status. For the most up-to-date information, always refer to the latest version in the repository.
**Current Version**: 0.9.0