Dev (#13)
* Fixed dependency * Updates to NeoDictionary * Changes to NeoDictionary * Started working on a Git implementation to integrate into Game Engines in the future * Added commit functionality to the git library * New changes * Added select for NeoDictionary.cs * Fixed issue with previous new method * Added a Benchmarking Tool to be used mostly in game engines * Added IndexOf to NeoDictionary.cs * Added new method for BenchmarkUtility.cs * added an instacedobject class * Added a new shuffle method for lists * fixed return type * Added new Changelog generator * Added new Game logic library to assist with game projects * Added Web Project * Added Nuget package configs * Add workflow for publishing game library NuGet package * Add README for OmegaLeo's Helper Library * Updated Website to reflect all libraries * Fixed missing library in Changelog * Added Contributing and Code of Conduct * Fixed web project * new documentation changes * fix packages * Fixed DocumentationHelper package dependencies * Added Serilog * Added logging * Fixed documentation * Added logging for cache * fixed documentation * Updated README.md * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update OmegaLeo.HelperLib.Web/Controllers/HomeController.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update OmegaLeo.HelperLib.Web/Controllers/HomeController.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fix error * changes for Github Packages * Cleanup --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit was merged in pull request #13.
This commit is contained in:
@@ -1,5 +1,8 @@
|
||||
# Omega Leo's Helper Library
|
||||
|
||||
[](https://github.com/omegaleo/HelperLib/actions/workflows/nuget-publish.yml)
|
||||
[](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).
|
||||
|
||||
Reference in New Issue
Block a user