<a href="#"><img src="https://github.com/ZacharyPatten/Towel/blob/main/.github/Resources/Logo.svg?raw=true" height="150"></a> <h1 align="center"> Towel </h1> A .NET library intended to make coding a bit more towelerable: data structures, algorithms, mathematics, metadata, extensions, console, and more. :)

"It's a tough galaxy. If you want to survive, you've gotta know... where your towel is." - Ford Prefect

Note This project has a goal of keeping up-to-date on modern coding practices rather than maintaining backwards compatibility such as targetting the latest non-preview version of .NET and embracing favorable breaking changes ("Semantic Versioning" is not being respected at this time).

Getting Started

<details> <summary> Run The Included Examples [Expand] </summary>

Towel has Examples included in this repository.

Download this repository and unzip the contents.

There are no custom build processes. Towel should build with any standard .NET build process, but one of the following is recommended:
<details> <summary> Visual Studio [Expand] </summary> 

Install Visual Studio if not already installed.

Open the <a href="Towel.sln"><img src="https://raw.githubusercontent.com/ZacharyPatten/Towel/main/.github/Resources/file-16.svg" title="File"></a> Towel.sln file in Visual Studio.

(optional) Here are some settings you change in Visual Studio.

 </details> <details> <summary> Visual Studio Code [Expand] </summary> 

Install the .NET SDK if not already installed.

Install Visual Studio Code if not already installed.

Open the <a href="#"><img src="https://raw.githubusercontent.com/ZacharyPatten/Towel/main/.github/Resources/file-directory-16.svg" title="Directory"></a> root folder of the repository in Visual Studio Code.

The following files are included in the repository:

.vscode/extensions.json recommends Vistual Studio Code extension dependencies

.vscode/launch.json includes the configurations for debugging the examples

.vscode/settings.json automatically applies settings to the workspace

.vscode/tasks.json includes the commands to build the projects

Visual Studio Code Extensions (will be prompted to install these when you open the folder):

ms-vscode.csharp C# support

formulahendry.dotnet-test-explorer (optional) MSTest unit testing support

aisoftware.tt-processor (optional) T4 Template support

zbecknell.t4-support (optional) T4 Template syntax highlighting

 </details>

</details> <details> <summary> Use Towel In Your .NET Projects [Expand] </summary>

Your project must target the same or newer version of .NET as Towel. See this documentation on how to check the current target of your project. Towel targets the following version of .NET: <a href="https://dotnet.microsoft.com/download"><img src="https://img.shields.io/badge/dynamic/xml?color=%23512bd4&label=target&query=%2F%2FTargetFramework%5B1%5D&url=https%3A%2F%2Fraw.githubusercontent.com%2FZacharyPatten%2FTowel%2Fmain%2FSources%2FTowel%2FTowel.csproj&logo=.net" title="Go To .NET Download"></a>

Towel has a nuget package: <a href="https://www.nuget.org/packages/Towel"><img src="https://img.shields.io/nuget/v/Towel.svg?logo=nuget" title="Go To Nuget Package"/></a> Instructions on how to reference the package are included on nuget.org (click the badge).
If you use Towel and would be willing to show it, here is a badge you can copy-paste into your readme: <a href="#"><img src="https://github.com/ZacharyPatten/Towel/blob/main/.github/Resources/UsingTowel.svg?raw=true" title="Go To Towel"></a>
<a href="https://github.com/ZacharyPatten/Towel"><img src="https://github.com/ZacharyPatten/Towel/blob/main/.github/Resources/UsingTowel.svg?raw=true" title="Go To Towel"></a>
Share your work. If you use Towel in one of your projects we want to hear about it. :)

</details> <details> <summary> View Documentation [Expand] </summary>

Change Log: https://github.com/ZacharyPatten/Towel/releases

docfx generated API documentation reference: <a href="https://zacharypatten.github.io/Towel/index.html"><img src="https://github.com/ZacharyPatten/Towel/blob/main/.github/Resources/docfx-badge.svg?raw=true" title="Go To Docfx Documentation"></a>

Coverlet + ReportGenerator generated test coverage report: <a href="https://zacharypatten.github.io/Towel/coveragereport/index.html"><img src="https://img.shields.io/badge/dynamic/xml?color=yellow&label=coverage&query=%2F%2Fcoverage%5B1%5D%2F%40line-rate-percentage&url=https%3A%2F%2Fraw.githubusercontent.com%2FZacharyPatten%2FTowel%2Fgh-pages%2Fcoveragereport%2Fcoverage.xml" title="Go Test Coverage Report"/></a>

BenchmarkDotNet generated benchmarking: https://zacharypatten.github.io/Towel/articles/benchmarks.html

Relevant Articles:

MSDN Accessing XML Documentation Via Reflection

Beginner's Guide To Console Input In C#

Generating Unique Random Data

Random Generation (with efficient exclusions)

Omnitree

C# Generic Math

File Structure Overview (except for <a href="https://github.com/ZacharyPatten/Towel/tree/gh-pages"><img src="https://raw.githubusercontent.com/ZacharyPatten/Towel/main/.github/Resources/git-branch-16.svg" title="Branch"></a> gh-pages):

<a href=".github"><img src="https://raw.githubusercontent.com/ZacharyPatten/Towel/main/.github/Resources/file-directory-16.svg" title="Directory"></a> .github content regarding the GitHub repoistory.

<a href=".github/ISSUE_TEMPLATE"><img src="https://raw.githubusercontent.com/ZacharyPatten/Towel/main/.github/Resources/file-directory-16.svg" title="Directory"></a> ISSUE_TEMPLATE templates for issue submissions to the GitHub repository

<a href=".github/Resources"><img src="https://raw.githubusercontent.com/ZacharyPatten/Towel/main/.github/Resources/file-directory-16.svg" title="Directory"></a> Resources resources such as image files

<a href=".github/workflows"><img src="https://raw.githubusercontent.com/ZacharyPatten/Towel/main/.github/Resources/file-directory-16.svg" title="Directory"></a> workflows GitHub Actions workflows

<a href=".github/workflows/Continuous Integration.yml"><img src="https://raw.githubusercontent.com/ZacharyPatten/Towel/main/.github/Resources/play-16.svg"

Towel

Install / Use

README

Getting Started