-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Organzied README to be consistent with VS Code guidance. Includes not…
…es for version 1.0.0
- Loading branch information
Showing
1 changed file
with
9 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,16 @@ | ||
# ANSYS CFX Lanugauge Extension: | ||
|
||
## Intro: | ||
This is a extension made for VS Code meant to help with lanugauge highlighting and code folding for script lanugages involving ANSYS CFX workflows. CFX is a Computational Fluid Dynamics (CFD) software package within the Computer Aided Engineering (CAE) package ANSYS. This extensions is specifically designed to be used with .ccl and .cst files which are the pre- and post-processing scripts within the program. | ||
This is a extension meant to help with syntax highlighting and code folding for script lanugages involving ANSYS CFX workflows. CFX is a Computational Fluid Dynamics (CFD) software package within the Computer Aided Engineering (CAE) package ANSYS. This extensions is specifically designed to be used with .ccl and .cst files which are the pre- and post-processing scripts within the program. | ||
|
||
## TODO: | ||
- [x] Add comment syntax highlighting | ||
- [x] Add units highlighting | ||
- [ ] make surrounding punctuation (parentheses and brackets) highlited | ||
- [ ] Investigate Theme coloring to make objects different | ||
|
||
## Helpful Links | ||
- VS Code Language Extension Documentation: | ||
- https://code.visualstudio.com/docs/extensionAPI/extension-points#_contributeslanguages | ||
- https://code.visualstudio.com/docs/extensionAPI/extension-points#_contributesgrammars | ||
- https://code.visualstudio.com/docs/extensions/themes-snippets-colorizers#_adding-a-new-language-colorizer | ||
## Features | ||
|
||
- Similar Language extensions: | ||
- https://github.com/shenbo/apdl-syntaxes-vscode | ||
|
||
- TextMate Grammar stuff: | ||
- https://manual.macromates.com/en/language_grammars | ||
- https://www.sublimetext.com/docs/3/scope_naming.html | ||
- http://www.apeth.com/nonblog/stories/textmatebundle.html \<\< really helpful | ||
- Syntax highliting | ||
- Includes specific highliting for CCL built-in functions and constants | ||
- Code folding | ||
|
||
- Maybe Later Stuff: | ||
- https://code.visualstudio.com/docs/extensions/themes-snippets-colorizers#_add-to-your-language-support-extension | ||
- https://code.visualstudio.com/docs/extensions/testing-extensions | ||
- https://code.visualstudio.com/docs/extensionAPI/language-support | ||
|
||
## Release Notes | ||
|
||
### 1.0.0 | ||
Initial release, basic syntax highliting | ||
|