Migrated CST notebook from .NET Labs

- Added code of conduct
- Updated README with requirements
This commit is contained in:
Tony Bark 2020-12-08 18:46:52 -05:00
parent 2d6a9bb1d2
commit 0dce5e27ea
5 changed files with 296 additions and 2 deletions

View file

@ -1,6 +1,8 @@
# CST.NET
Caret-Separated Text (or CST) is a key-value pair format represented by numbers or words as keys and the value is the string enclosed between carets (^) that contains the contents. CST.NET is a library for prasing the CST format.
[![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 numbers or words as keys and the value is the string enclosed between carets (^) that contains the contents. CST.NET is a library for parsing the CST format.
## Example
@ -17,7 +19,15 @@ Console.WriteLine(example);
## To-do
- [ ] Support for arguments
- [ ] Support for arguments (e.g. ``%1``)
## Requirements
### Prerequisites
- [.NET](https://dotnet.microsoft.com/download) 5+ or Core 3.1
- [.NET Interactive](https://github.com/dotnet/interactive/blob/main/README.md) for notebooks
- [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.dotnet-interactive-vscode) (does not require Jupyter)
- [nteract](https://nteract.io/) (requires Jupyter)
## License