cstdotnet/README.md

29 lines
1.5 KiB
Markdown
Raw Normal View History

2022-04-29 06:39:56 -04:00
# CSTNet
2020-12-08 17:56:38 -05:00
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)
2022-04-29 06:39:56 -04:00
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.
CST.NET uses .NET's built-in indexing extension function to accomplish locating of each respective key. As a consequence, it does not matter what you use for keys. I added an additional normalization to the pipeline that converts the document's line endings to the system's, in order to prevent crashes.
2020-12-08 17:56:38 -05:00
## Usage
2020-12-08 17:56:38 -05:00
See [usage.md](./usage.md).
2020-12-08 17:56:38 -05:00
## To-do
- [ ] Support for arguments (e.g. ``%1``)
## Known issues
- Skipping comments is a little unpredictable.
## Requirements
2022-04-29 06:39:56 -04:00
- [.NET](https://dotnet.microsoft.com/download) 6 or later.
- [.NET Interactive](https://github.com/dotnet/interactive/blob/main/README.md) for notebooks (optional).
2022-04-29 06:39:56 -04:00
- [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.dotnet-interactive-vscode) or [nteract](https://nteract.io/).
2020-12-08 17:56:38 -05:00
## License
I license this project under the MIT license - see [LICENSE](LICENSE) for details.