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:
2025-09-11 11:27:32 -04:00
parent 1e86bc6d16
commit 4c8286def0
3 changed files with 75 additions and 0 deletions

25
.gitignore vendored Normal file
View File

@@ -0,0 +1,25 @@
# Build artifacts
target/
*.wasm
*.dylib
*.so
*.dll
*.dylib
*.a
*.o
# Node modules
node_modules/
# IDE files
.vscode/
.idea/
*.swp
*.swo
# OS files
.DS_Store
Thumbs.db
# Logs
*.log

50
README.md Normal file
View File

@@ -0,0 +1,50 @@
# tree-sitter-xml
A [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) grammar for XML files as used in the [nand2tetris](https://www.nand2tetris.org/) course.
## Supported File Types
- `.xml` - XML compiler output files
## Features
- **Syntax highlighting** for XML elements, attributes, and text content
- **Code navigation** with outline support for XML structure
- **Bracket matching** for XML tags
- **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**: XML
- **Scope**: `source.xml`
- **File Types**: `.xml`
- **Node Types**: `element`, `tag_name`, `attribute`, `attribute_name`, `attribute_value`, `text`, `comment`
## 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

Binary file not shown.