diff --git a/README.md b/README.md index e69de29..2ac6c67 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,49 @@ +# NX Postprocessor Support + +A comprehensive VS Code extension providing language support for NX CAD postprocessor development, including CDL (Cutter Definition Language), TCL, and DEF files. + +## Features + +- **Syntax Highlighting** - Full syntax highlighting for CDL, TCL, and DEF files +- **Language Server Integration** - Powered by `tclint` for advanced language features +- **Code Formatting** - Automatic code formatting for all supported file types +- **Multi-language Support** - Supports NX CDL, TCL, and DEF file formats +- **Intelligent Code Analysis** - Linting and error detection for postprocessor code +- **Auto-completion** - Context-aware code completion for faster development + +## Supported File Types + +- `.cdl` - NX Cutter Definition Language files +- `.tcl` - NX TCL postprocessor files +- `.def` - NX Definition files + +## Installation + +1. Install from the VS Code Marketplace +2. Open any `.cdl`, `.tcl`, or `.def` file +3. The extension will automatically activate and provide language support + +## Configuration + +The extension can be configured through VS Code settings: + +- `nx-post-support.interpreter` - Specify custom Python interpreter path for the language server +- `nx-post-support.formatter` - Enable/disable the TCL formatter (default: false) + +## Usage + +Simply open any supported file type and enjoy: + +- Syntax highlighting +- Error detection and linting +- Code completion +- Code formatting (Format Document command) +- Hover information + +## Contributing + +This extension is actively maintained. For issues or feature requests, please visit our [repository](https://git.cbsk-tech.de/Christoph/nx_post_support.git). + +## License + +MIT License - see LICENSE file for details.