cstdotnet/README.md

# CST.NET

[![GitHub license](https://img.shields.io/github/license/tonytins/cstdotnet)](https://github.com/tonytins/cstdotnet/blob/main/LICENSE) ![Nuget](https://img.shields.io/nuget/v/cstnet) ![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.

## Changelog

See [changelog.md](./changelog.md)

## 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.
IUIText interface for UIText class - Added test to VSCode tasks - New deploy keys - Renamed dpkgpackage workflow to publish - Bump to version to 2.0, beta 1 2022-10-10 02:54:46 -04:00			`# CST.NET`
Add project files. 2020-12-08 17:56:38 -05:00
Nuget badge in README - Explained UIText and Release Cycle a lot more clearly, I hope 2022-10-10 04:27:15 -04:00			[![GitHub license](https://img.shields.io/github/license/tonytins/cstdotnet)](https://github.com/tonytins/cstdotnet/blob/main/LICENSE) ![Nuget](https://img.shields.io/nuget/v/cstnet) ![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)
Migrated CST notebook from .NET Labs - Added code of conduct - Updated README with requirements 2020-12-08 18:46:52 -05:00
Relicensed under BSD 3-clause 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.

Nuget badge in README - Explained UIText and Release Cycle a lot more clearly, I hope 2022-10-10 04:27:15 -04:00			`## Changelog`

			`See [changelog.md](./changelog.md)`

Proper unit tests - Changed example section to usage and explained how it was used in TSO 2020-12-08 20:13:18 -05:00			`## Usage`
Add project files. 2020-12-08 17:56:38 -05:00
UIText class The UIText class allows for travseing in "/<directory>/<language>.dir" directories and searching for CST files by their Id number. See usage.md for more info. 2020-12-13 07:48:15 -05:00			`See [usage.md](./usage.md).`
Proper unit tests - Changed example section to usage and explained how it was used in TSO 2020-12-08 20:13:18 -05:00
Add project files. 2020-12-08 17:56:38 -05:00			`## To-do`

IUIText interface for UIText class - Added test to VSCode tasks - New deploy keys - Renamed dpkgpackage workflow to publish - Bump to version to 2.0, beta 1 2022-10-10 02:54:46 -04:00			- [ ] Support for parameters (e.g. ``%1``)
Migrated CST notebook from .NET Labs - Added code of conduct - Updated README with requirements 2020-12-08 18:46:52 -05:00
Support for funding - Issue and pull request templates 2020-12-09 22:34:45 -05:00			`## Known issues`

This release drops .NET Standard in favor of .NET 6. There are a lot of significant under the hood changes with the release. See the change log for details. 2021-11-19 13:52:26 -05:00			`- Skipping comments is a little unpredictable.`
Support for funding - Issue and pull request templates 2020-12-09 22:34:45 -05:00
Migrated CST notebook from .NET Labs - Added code of conduct - Updated README with requirements 2020-12-08 18:46:52 -05:00			`## Requirements`

Relicensed under BSD 3-clause 2022-04-29 06:39:56 -04:00			`- [.NET](https://dotnet.microsoft.com/download) 6 or later.`
Project overhaul 2022-07-21 10:23:31 -04:00			`- IDEs or Editors`
			`- [Visual Studio Code](https://code.visualstudio.com/)`
			`- [Visual Studio 2022](https://visualstudio.microsoft.com/)`
This release drops .NET Standard in favor of .NET 6. There are a lot of significant under the hood changes with the release. See the change log for details. 2021-11-19 13:52:26 -05:00			`- [.NET Interactive](https://github.com/dotnet/interactive/blob/main/README.md) for notebooks (optional).`
IUIText interface for UIText class - Added test to VSCode tasks - New deploy keys - Renamed dpkgpackage workflow to publish - Bump to version to 2.0, beta 1 2022-10-10 02:54:46 -04:00			`- [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.dotnet-interactive-vscode) or [nteract](https://nteract.io/).`
Add project files. 2020-12-08 17:56:38 -05:00
			`## License`

IUIText interface for UIText class - Added test to VSCode tasks - New deploy keys - Renamed dpkgpackage workflow to publish - Bump to version to 2.0, beta 1 2022-10-10 02:54:46 -04:00			`I license this project under the BSD-3-Clause license - see [LICENSE](LICENSE) for details.`