This commit is contained in:
2026-02-13 14:25:50 +00:00
parent e2069a938e
commit 3e348a68b9
21 changed files with 2253 additions and 223 deletions
+18
View File
@@ -1,5 +1,8 @@
# Omega Leo's Helper Library
[![Publish NuGet](https://github.com/omegaleo/HelperLib/actions/workflows/nuget-publish.yml/badge.svg)](https://github.com/omegaleo/HelperLib/actions/workflows/nuget-publish.yml)
[![Publish JetBrains Plugin](https://github.com/omegaleo/HelperLib/actions/workflows/jetbrains-publish.yml/badge.svg)](https://github.com/omegaleo/HelperLib/actions/workflows/jetbrains-publish.yml)
Lightweight utility library for C\# projects and game development helpers.
## Table of contents
@@ -22,12 +25,15 @@ Lightweight utility library for C\# projects and game development helpers.
- Helpers that favor clarity and testability
- Game development specific helpers in the `OmegaLeo.HelperLib.Game` package
- Changelog generation utilities in the `OmegaLeo.HelperLib.Changelog` package
- **JetBrains Rider plugin** for displaying custom documentation attributes in Quick Documentation (Ctrl+Q)
- Lightweight and easy to integrate into existing projects
- Well-documented and maintained
- Open source under the AGPL v3 License
## Install
### NuGet Packages
Add the library to your project via NuGet:
```bash
@@ -36,6 +42,18 @@ dotnet add package OmegaLeo.HelperLib.Game
dotnet add package OmegaLeo.HelperLib.Changelog
dotnet add package OmegaLeo.HelperLib.Documentation
```
### JetBrains Rider Plugin
For enhanced IDE support with custom documentation attributes:
1. Open Rider
2. Go to **Settings** → **Plugins**
3. Search for "HelperLib Documentation Provider"
4. Click **Install**
5. Restart Rider
The plugin displays `[Documentation]` attributes in Quick Documentation (Ctrl+Q). [Learn more →](OmegaLeo.HelperLib.Jetbrains/README.md)
## Documentation
The documentation for this project can be found at [https://library.omegaleo.dev](https://library.omegaleo.dev).