diff --git a/README.md b/README.md index 20f783e..f791e95 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,53 @@ -# [CST.NET](http://CST.NET) - -<p align="center"><a href="https://github.com/tonytins/cstdotnet/blob/main/LICENSE"><img src="https://img.shields.io/github/license/tonytins/cstdotnet" alt="GitHub license"></a> <a href="https://github.com/tonytins/cstdotnet/actions?query=workflow%3Abuild.yml"><img src="https://img.shields.io/github/actions/workflow/status/tonytins/cstdotnet/build.yml" alt="GitHub Workflow Status"></a> <img src="https://img.shields.io/github/commit-activity/w/tonytins/cstdotnet" alt="GitHub commit activity"> <a href="code_of_conduct.md"></br> <img src="https://img.shields.io/codeclimate/maintainability-percentage/tonytins/cstdotnet" alt="Code Climate maintainability"> <img src="https://img.shields.io/nuget/dt/CSTNet" alt="NuGet Downloads"> <a href="https://www.nuget.org/packages/tonybark.updatetools"><img src="https://img.shields.io/nuget/v/cstnet.svg" /></a></br><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant"></a></br> </p> +# 🔠 CST.NET CST.NET is a library for parsing Maxis' key-value pair format. It can be used in conjunction with your own custom frameworks, or the original `UIText` APIs. 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. ` ^^`) Any text which is not enclosed with carets is considered a comment and ignored. Neither strings nor comments may use the caret character. -## Changelog +## 🛠 Features -See [changelog.md](./doc/changelog.md) +* [x] Native support for Sims Online's `.cst `files. +* [x] UIText Support +* [ ] Variable support -## Usage +## 📅 Support & Update Cadence -See [/docs](./doc/README.md). +| Type | Frequency | Notes | +| ------------ | -------------------- | ---------------------------------------- | +| Minor Update | Every 3–6 months | Small enhancements, non-breaking changes | +| Patch Update | Monthly or as needed | Bug fixes, security updates | +| Major Update | As needed | Framework upgrades, major refactors | -## To-do +* Reserve months: June (Mid-Year Chill) & December (End-Year Freeze) -- [ ] Support for parameters (e.g. `%1`) +## 🧘 Sustainability Practices -## Known issues +* 20% creative/recovery space built into development +* Mandatory cooldowns after major launches (minimum 1 week) +* Crisis Mode Activates if: + * Critical vulnerabilities + * Framework-breaking issues -- Skipping comments is a little unpredictable. +## 🛡️ Support Levels -## Requirements +* [ ] Active Support +* [x] Limited Support (Security patches only) +* [x] Maintenance Mode (Dependency-only updates) +* [ ] Archived (No active work planned) -- [.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/). +## ⏰ Project Timeline +| Milestone | Target Date | Status | +| ------------------ | ----------- | ------- | +| First Stable Build | 12/13/2020 | Done | +| Feature Complete | N/A | Planned | +| Maintenance Phase | N/A | Planned | -# Contributing +## 📓 Project Notes -You can contribute to CST.NET by testing cutting edge features in the latest releases, filing bugs, and joining in the discussion on our forums! +* This all began as a "what if?" What if I could make my own? So, I did. First from a Jupyter notebook and then a full-fledged project that technically has a support cycle. +* While this project is technically feature complete, it is not a full drop-in replacement as it lacks variable (`%[digit]`) parsing. -* [Getting Started](https://github.com/tonytins/cstdotnet/wiki) -* [Project Structure](https://github.com/tonytins/cstdotnet/wiki/Project-structure) -* [Coding Standards](https://github.com/tonytins/cstdotnet/wiki/Coding-standards) -* [Pull Requests](https://github.com/tonytins/cstdotnet/pulls): [Open](https://github.com/tonytins/cstdotnet/pulls)/[Closed](https://github.com/tonytins/cstdotnet/issues?q=is%3Apr+is%3Aclosed) +## 📄 License -Looking for something to do? Check out the issues tagged as [help wanted](https://github.com/tonytins/cstdotnet/labels/help%20wanted) to get started. - -Regarding translations, full object and UI translations should currently be released on the forums. This is far from perfect and is due to be reworked. Stay tuned! - -## License - -I license this project under the BSD-3-Clause license - see [LICENSE](LICENSE) for details. \ No newline at end of file +I license this project under BSD-3-Clause license — see the [LICENSE](LICENSE) file for full text.