mirror of
https://github.com/soconnor0919/tree-sitter-compare-output.git
synced 2026-02-04 23:56:33 -05:00
Add README, .gitignore, and clean up build artifacts
- Added comprehensive README with usage instructions - Added .gitignore to prevent build artifacts from being committed - Removed target/ directories and duplicate WASM files - Cleaned up parser binaries and test files
This commit is contained in:
48
README.md
Normal file
48
README.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# tree-sitter-compare-output
|
||||
|
||||
A [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) grammar for Compare/Output files as used in the [nand2tetris](https://www.nand2tetris.org/) course.
|
||||
|
||||
## Supported File Types
|
||||
|
||||
- `.cmp` - Compare/Output files for test result verification
|
||||
|
||||
## Features
|
||||
|
||||
- **Syntax highlighting** for table structures and data values
|
||||
- **Code navigation** with outline support
|
||||
- **Integration** with Zed editor and other Tree-sitter compatible editors
|
||||
|
||||
## Usage
|
||||
|
||||
This grammar is designed to work with the [nand2tetris-zed](https://github.com/soconnor0919/nand2tetris-zed) extension for Zed editor, providing complete language support for the nand2tetris course.
|
||||
|
||||
## Grammar Details
|
||||
|
||||
- **Language**: Compare Output
|
||||
- **Scope**: `source.compare_output`
|
||||
- **File Types**: `.cmp`
|
||||
|
||||
## Development
|
||||
|
||||
### Building
|
||||
|
||||
```bash
|
||||
# Generate parser
|
||||
tree-sitter generate
|
||||
|
||||
# Build parser
|
||||
tree-sitter build
|
||||
|
||||
# Test grammar
|
||||
tree-sitter test
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see [LICENSE](LICENSE) file for details.
|
||||
|
||||
## Related
|
||||
|
||||
- [nand2tetris-zed](https://github.com/soconnor0919/nand2tetris-zed) - Complete Zed extension
|
||||
- [nand2tetris.org](https://www.nand2tetris.org/) - Course website
|
||||
- [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) - Parser generator
|
||||
Reference in New Issue
Block a user