mirror of
https://github.com/tonytins/cstdotnet.git
synced 2025-03-21 16:11:21 +00:00
e40ba5a904
- Added test to VSCode tasks - New deploy keys - Renamed dpkgpackage workflow to publish - Bump to version to 2.0, beta 1
30 lines
1.5 KiB
Markdown
30 lines
1.5 KiB
Markdown
# CST.NET
|
|
|
|
[](https://github.com/tonytins/cstdotnet/blob/main/LICENSE)   [](code_of_conduct.md)
|
|
|
|
Caret-Separated Text (or CST) is a key-value pair format represented by digits or words as keys and the value as text enclosed between carets. (e.g. ``<key> ^<text>^``) Any text which is not enclosed with carets is considered a comment and ignored. Neither strings nor comments may use the caret character. CST.NET is a library for parsing the CST format.
|
|
|
|
## Usage
|
|
|
|
See [usage.md](./usage.md).
|
|
|
|
## To-do
|
|
|
|
- [ ] Support for parameters (e.g. ``%1``)
|
|
|
|
## Known issues
|
|
|
|
- Skipping comments is a little unpredictable.
|
|
|
|
## Requirements
|
|
|
|
- [.NET](https://dotnet.microsoft.com/download) 6 or later.
|
|
- IDEs or Editors
|
|
- [Visual Studio Code](https://code.visualstudio.com/)
|
|
- [Visual Studio 2022](https://visualstudio.microsoft.com/)
|
|
- [.NET Interactive](https://github.com/dotnet/interactive/blob/main/README.md) for notebooks (optional).
|
|
- [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.dotnet-interactive-vscode) or [nteract](https://nteract.io/).
|
|
|
|
## License
|
|
|
|
I license this project under the BSD-3-Clause license - see [LICENSE](LICENSE) for details.
|