tonytins/cstdotnet
1
0
Fork 0
mirror of https://github.com/tonytins/cstdotnet.git synced 2025-03-15 06:01:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Nuget badge in README

Browse source 
- Explained UIText and Release Cycle a lot more clearly, I hope
This commit is contained in:
Tony Bark 2022-10-10 04:27:15 -04:00
parent 9d98055df3
commit f01ac8970a
2 changed files with 12 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -1,9 +1,13 @@
# CST.NET
[![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)
[![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).

12
changelog.md
View file

@ -2,15 +2,17 @@
## 2.0.100
This version supports both .NET Standard 2.1 and .NET 6 and brings with it (much needed) quality of life changes on the project side of things. Apart from that, nothing has changed to the API itself apart from much needed documentation.
This version supports both .NET Standard 2.1 and .NET 6 and brings with it (much needed) quality of life changes internally. Apart from that, nothing has changed to the API itself apart from much needed documentation.
From this version onward, CSTNet will only target LTS releases. This is why .NET 5 was skipped, despite the initial platform unification.
### New Release Cycle
Because this library has no third-party dependencies, CST.NET's release cycle will generally follow .NET's LTS cycle. This is why .NET 5 was skipped. Minor releases will consist of targeting latest LTS. For example, 2.1 will drop Standard 2.1 (ironically) in favor of .NET 8.0, 6.0 will continue to be targeted until it's end of life and 2.2 will strictly target 8.0. This should ensure continues security updates and Enterprise-grade support.
### UIText class and interface
The ``UIText`` class implants the ``IUITEext`` interface. It allows for traversing in ``/<directory>/<language>.dir`` directories and searching for CST files by their Id number. (e.g. _*154*_miscstrings.cst). By defualt, the base path is ``/<program directory>/uitext/<language>.dir``. For more info, see [usage.md](./usage.md).
Based on FreeSO's API, the ``UIText`` class allows for traversing in ``/<directory>/<language>.dir`` directories and searching CST files by their Id number. (e.g. _*154*_miscstrings.cst). By defualt, the base path is ``/<program directory>/uitext/<language>.dir``. You may also create your own implementation based on these APIs using the ``IUIText`` interface which mine also uses.
You can build your own version the
For more info, see [usage.md](./usage.md).
## 1.0.300
@ -28,7 +30,7 @@ You can build your own version the
## 1.0.1
Despite only being a point release, this includes a major refinement to the normalizing algorithm.
Despite only being a patch release, this includes a major refinement to the normalizing algorithm.
### Rewrote normalizing algorithm