diff --git a/OmegaLeo.HelperLib.sln b/OmegaLeo.HelperLib.sln index 6026162..b3024e3 100644 --- a/OmegaLeo.HelperLib.sln +++ b/OmegaLeo.HelperLib.sln @@ -14,6 +14,14 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OmegaLeo.HelperLib.Web", "O EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OmegaLeo.HelperLib.Game", "OmegaLeo.HelperLib.Game\OmegaLeo.HelperLib.Game.csproj", "{488BC3EA-9B7A-4251-B802-22EB098D6494}" EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SolutionFiles", "SolutionFiles", "{00CF0543-37F3-41DE-B78F-8ADA6DE796ED}" + ProjectSection(SolutionItems) = preProject + README.md = README.md + CODE_OF_CONDUCT.md = CODE_OF_CONDUCT.md + CONTRIBUTING.md = CONTRIBUTING.md + LICENSE = LICENSE + EndProjectSection +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU diff --git a/README.md b/README.md index 9d74f2a..5c86988 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,52 @@ # HelperLib -Library to help with C# projects and with game development using C# + +Lightweight utility library for C\# projects and game development helpers. + +## Table of contents + +- [Overview](#overview) +- [Features](#features) +- [Install](#install) +- [Documentation](#documentation) +- [Contributing](#contributing) +- [License](#license) +- [Socials](#socials) + +## Overview + +`HelperLib` contains small helpers and abstractions commonly useful in application and game development (helpers for collections, math, and utilities to keep game and engine code concise). + +## Features + +- Small, focused utilities for C\# +- 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 +- Lightweight and easy to integrate into existing projects +- Well-documented and maintained +- Open source under the AGPL v3 License + +## Install + +Add the library to your project via NuGet: + +```bash +dotnet add package OmegaLeo.HelperLib +dotnet add package OmegaLeo.HelperLib.Game +dotnet add package OmegaLeo.HelperLib.Changelog +``` + +## Documentation +The documentation for this project can be found at [https://library.omegaleo.dev](https://library.omegaleo.dev). +This documentation is automatically generated from the code using the [NetFlow.DocumentationHelper.Library](https://github.com/omegaleo/Netflow.DocumentationHelper). + +## Contributing +Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines. + +## License +This project is licensed under the AGPL v3 License. See the [LICENSE](LICENSE) file for details + +## Socials +[![Youtube](https://img.shields.io/youtube/channel/subscribers/UCsdYKC7EK4Z_cpgWt0YiO9Q?style=plastic&label=Youtube&color=red +)](https://youtube.com/@omegaleo) [![Twitch](https://img.shields.io/twitch/status/professorleo?style=plastic&logoColor=purple&color=purple +)](https://twitch.tv/professorleo) [![Discord](https://badgen.net/discord/online-members/Gp87EyBDvD?icon=discord)](https://discord.com/invite/Gp87EyBDvD)