cstdotnet/README.md

# Sixam.CST

[![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)

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. Sixam.CST is a library for parsing the CST format.

## Usage

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

## To-do

- [ ] Support for arguments (e.g. ``%1``)

## Known issues

- Skipping comments is a little unpredictable.

## Requirements

- [.NET](https://dotnet.microsoft.com/download) 6+.
- [.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.
Change name in markdown documents too 2020-12-11 04:16:06 -05:00			`# Sixam.CST`
Add project files. 2020-12-08 17:56:38 -05:00
Migrated CST notebook from .NET Labs - Added code of conduct - Updated README with requirements 2020-12-08 18:46:52 -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)`

Fixed the multiline parsing in the v2 format. 2020-12-12 03:32:09 -05: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. Sixam.CST is a library for parsing the CST format.
Add project files. 2020-12-08 17:56:38 -05:00
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`

Migrated CST notebook from .NET Labs - Added code of conduct - Updated README with requirements 2020-12-08 18:46:52 -05:00			- [ ] Support for arguments (e.g. ``%1``)

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`

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](https://dotnet.microsoft.com/download) 6+.`
			`- [.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/)`
Add project files. 2020-12-08 17:56:38 -05:00
			`## License`

			`I license this project under the MIT license - see [LICENSE](LICENSE) for details.`