tonytins/cstdotnet
1
0
Fork 0
mirror of https://github.com/tonytins/cstdotnet.git synced 2025-10-15 16:03:49 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Project overhaul

Browse source
This commit is contained in:
Tony Bark 2022-07-21 10:23:31 -04:00
parent 3de1fc5eca
commit 84c27a1b14
11 changed files with 78 additions and 169 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -1,9 +1,11 @@
# CSTNet
[![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)
[![GitHub license](https://img.shields.io/github/license/tonytins/cstdotnet)](https://github.com/tonytins/cstdotnet/blob/main/LICENSE) ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/tonytins/cstdotnet/.NET/main) ![GitHub commit activity](https://img.shields.io/github/commit-activity/w/tonytins/cstdotnet) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](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.
## Architecture
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.
## Usage
@ -21,9 +23,12 @@ See [usage.md](./usage.md).
## 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 MIT license - see [LICENSE](LICENSE) for details.
I license this project under the BSD-3-Clause license - see [LICENSE](LICENSE) for details.