diff --git a/.github/workflows/Continuous Integration.yml b/.github/workflows/Continuous Integration.yml index b9cd3331..f860725f 100644 --- a/.github/workflows/Continuous Integration.yml +++ b/.github/workflows/Continuous Integration.yml @@ -3,14 +3,14 @@ on: workflow_dispatch: push: branches: - - master + - main paths-ignore: - '.vscode/**' - '.github/**' - 'README.md' pull_request: branches: - - master + - main paths-ignore: - '.vscode/**' - '.github/**' diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml index ab1b4856..4c9a6b5b 100644 --- a/.github/workflows/Documentation.yml +++ b/.github/workflows/Documentation.yml @@ -3,7 +3,7 @@ on: workflow_dispatch: push: branches: - - master + - main paths: - 'Sources/Towel/**' - 'Tools/docfx_project/**' diff --git a/README.md b/README.md index 657dd22c..f96a056a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- +

@@ -15,13 +15,13 @@

- + - + - +

> _**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)._ @@ -34,9 +34,9 @@

-> Towel has [Examples](https://github.com/ZacharyPatten/Towel/tree/master/Examples) included in this repository. +> Towel has [Examples](https://github.com/ZacharyPatten/Towel/tree/main/Examples) included in this repository. > -> [Download](https://github.com/ZacharyPatten/Towel/archive/master.zip) this repository and unzip the contents. +> [Download](https://github.com/ZacharyPatten/Towel/archive/main.zip) 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: > @@ -48,7 +48,7 @@ > > > 1. Install [Visual Studio](https://visualstudio.microsoft.com/) if not already installed. > > -> > 2. Open the **`Towel.sln`** file in Visual Studio. +> > 2. Open the **`Towel.sln`** file in Visual Studio. > > > > _**Note** (optional) [Here are some recommended settings you change in Visual Studio](https://gist.github.com/ZacharyPatten/693f35653f6c21fbe6c85444792e524b)._ > @@ -65,7 +65,7 @@ > > > > 2. Install [Visual Studio Code](https://visualstudio.microsoft.com/) if not already installed. > > -> > 3. Open the **`root folder`** of the repository in Visual Studio Code. +> > 3. Open the **`root folder`** of the repository in Visual Studio Code. > > > > _**Note** The following files are included in the repository:_ > > - `.vscode/extensions.json` recommends Vistual Studio Code extension dependencies @@ -93,15 +93,15 @@ > Towel has a nuget package: > -> 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](https://docs.microsoft.com/en-us/dotnet/standard/frameworks). Towel targets the following version of .NET: +> 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](https://docs.microsoft.com/en-us/dotnet/standard/frameworks). Towel targets the following version of .NET: > > You can install the Towel nuget package with the `dotnet add package Towel --version XXXXX` command, or you can > manually add a reference to it in your `.csproj` files `` > (where `XXXXX` is the version to install). > -> If you use Towel and would be willing to show it, here is a badge you can copy-paste into your readme: +> If you use Towel and would be willing to show it, here is a badge you can copy-paste into your readme: > ```html -> +> > ``` > Share your work. If you use Towel in one of your projects we want to hear about it. :) @@ -116,7 +116,7 @@ > Change Log: https://github.com/ZacharyPatten/Towel/releases > -> [docfx](https://github.com/dotnet/docfx) generated API documentation reference: +> [docfx](https://github.com/dotnet/docfx) generated API documentation reference: > > [Coverlet](https://github.com/coverlet-coverage/coverlet) + [ReportGenerator](https://github.com/danielpalme/ReportGenerator) generated test coverage report: > @@ -130,29 +130,29 @@ > - [Omnitree](https://gist.github.com/ZacharyPatten/f21fc5c6835faea9be8ae4baab4e294e)
> - [C# Generic Math](https://gist.github.com/ZacharyPatten/8e1395a94928f2c7715cf939b0d0389c)
> -> File Structure Overview _(except for `gh-pages`)_: -> - `.github` content regarding the GitHub repoistory. -> - `ISSUE_TEMPLATE` templates for issue submissions to the GitHub repository -> - `Resources` resources such as image files -> - `workflows` [GitHub Actions](https://github.com/ZacharyPatten/Towel/actions) workflows -> - `Continuous Integration.yml` workflow for checking that code compiles and unit tests pass -> - `Towel Deployment.yml` workflow to manage [releases](https://github.com/ZacharyPatten/Towel/releases) and deploy [nuget packages](https://www.nuget.org/packages/Towel) -> - `Documentation.yml` workflow that runs [docfx](https://github.com/dotnet/docfx) + [Coverlet](https://github.com/coverlet-coverage/coverlet) + [ReportGenerator](https://github.com/danielpalme/ReportGenerator) to output [GitHub Pages](https://pages.github.com/) to `gh-pages` -> - `pull_request_template.md` template for when pull requests are created -> - `.vscode` confirguration files for if the code is opened in [Visual Studio Code](https://visualstudio.microsoft.com/) -> - `Examples` root folder for all the example projects -> - `Sources` root folder for the source code of released nuget packages -> - **`Towel` the root folder for all source code in the Towel nuget package** -> - `Tools` root folder for all support projects -> - `docfx_project` root folder for [docfx](https://github.com/dotnet/docfx) project (used in `Documentation.yml`) -> - `articles` root folder for all articless of the [docfx](https://github.com/dotnet/docfx) generated [GitHub Pages](https://pages.github.com/) website -> - `apidoc` root folder for all api overrides of the [docfx](https://github.com/dotnet/docfx) generated [GitHub Pages](https://pages.github.com/) website -> - `docfx.json` configuration file that controls [docfx](https://github.com/dotnet/docfx) -> - `index.md` home page of the [docfx](https://github.com/dotnet/docfx) generated [GitHub Pages](https://pages.github.com/) website -> - `toc.yml` primary navigation for the [docfx](https://github.com/dotnet/docfx) generated [GitHub Pages](https://pages.github.com/) website -> - `Towel_Benchmarking` project with all the benchmarking for the Towel project -> - `Towel_Generating` project with code generation for the Towel Project -> - `Towel_Testing` project with all unit tests for the Towel project (used in `Continuous Integration.yml` and `Documentation.yml`) +> File Structure Overview _(except for `gh-pages`)_: +> - `.github` content regarding the GitHub repoistory. +> - `ISSUE_TEMPLATE` templates for issue submissions to the GitHub repository +> - `Resources` resources such as image files +> - `workflows` [GitHub Actions](https://github.com/ZacharyPatten/Towel/actions) workflows +> - `Continuous Integration.yml` workflow for checking that code compiles and unit tests pass +> - `Towel Deployment.yml` workflow to manage [releases](https://github.com/ZacharyPatten/Towel/releases) and deploy [nuget packages](https://www.nuget.org/packages/Towel) +> - `Documentation.yml` workflow that runs [docfx](https://github.com/dotnet/docfx) + [Coverlet](https://github.com/coverlet-coverage/coverlet) + [ReportGenerator](https://github.com/danielpalme/ReportGenerator) to output [GitHub Pages](https://pages.github.com/) to `gh-pages` +> - `pull_request_template.md` template for when pull requests are created +> - `.vscode` confirguration files for if the code is opened in [Visual Studio Code](https://visualstudio.microsoft.com/) +> - `Examples` root folder for all the example projects +> - `Sources` root folder for the source code of released nuget packages +> - **`Towel` the root folder for all source code in the Towel nuget package** +> - `Tools` root folder for all support projects +> - `docfx_project` root folder for [docfx](https://github.com/dotnet/docfx) project (used in `Documentation.yml`) +> - `articles` root folder for all articless of the [docfx](https://github.com/dotnet/docfx) generated [GitHub Pages](https://pages.github.com/) website +> - `apidoc` root folder for all api overrides of the [docfx](https://github.com/dotnet/docfx) generated [GitHub Pages](https://pages.github.com/) website +> - `docfx.json` configuration file that controls [docfx](https://github.com/dotnet/docfx) +> - `index.md` home page of the [docfx](https://github.com/dotnet/docfx) generated [GitHub Pages](https://pages.github.com/) website +> - `toc.yml` primary navigation for the [docfx](https://github.com/dotnet/docfx) generated [GitHub Pages](https://pages.github.com/) website +> - `Towel_Benchmarking` project with all the benchmarking for the Towel project +> - `Towel_Generating` project with code generation for the Towel Project +> - `Towel_Testing` project with all unit tests for the Towel project (used in `Continuous Integration.yml` and `Documentation.yml`)

diff --git a/Tools/Towel_Benchmarking/Program.cs b/Tools/Towel_Benchmarking/Program.cs index 86dec8d3..f24d005d 100644 --- a/Tools/Towel_Benchmarking/Program.cs +++ b/Tools/Towel_Benchmarking/Program.cs @@ -72,7 +72,7 @@ public static void Main(string[] args) "", @"", "", - "The source code for all becnhmarks are in [Tools/ Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/master/Tools/Towel_Benchmarking).", + "The source code for all becnhmarks are in [Tools/ Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/main/Tools/Towel_Benchmarking).", "", }; File.WriteAllLines(benchmarks_mdPath, lines); @@ -85,7 +85,7 @@ public static void Main(string[] args) stringBuilder.AppendLine(); stringBuilder.AppendLine(@""); stringBuilder.AppendLine(); - stringBuilder.AppendLine("The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/master/Tools/Towel_Benchmarking)."); + stringBuilder.AppendLine("The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/main/Tools/Towel_Benchmarking)."); stringBuilder.AppendLine(); stringBuilder.AppendLine(output); if (updateDocumentation) diff --git a/Tools/docfx_project/api/index.md b/Tools/docfx_project/api/index.md index b0d7f78a..331f4682 100644 --- a/Tools/docfx_project/api/index.md +++ b/Tools/docfx_project/api/index.md @@ -4,4 +4,4 @@ Browse the api documentation. - + diff --git a/Tools/docfx_project/articles/benchmarks.md b/Tools/docfx_project/articles/benchmarks.md index 3d32a521..81e144ce 100644 --- a/Tools/docfx_project/articles/benchmarks.md +++ b/Tools/docfx_project/articles/benchmarks.md @@ -2,7 +2,7 @@ github repo -The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/master/Tools/Towel_Benchmarking). +The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/main/Tools/Towel_Benchmarking). - [Sorting Algorithms](benchmarks/SortBenchmarks.md) - [Data Structures](benchmarks/DataStructuresBenchmarks.md) diff --git a/Tools/docfx_project/articles/benchmarks/DataStructuresBenchmarks.md b/Tools/docfx_project/articles/benchmarks/DataStructuresBenchmarks.md index 2b83a311..1a8321a2 100644 --- a/Tools/docfx_project/articles/benchmarks/DataStructuresBenchmarks.md +++ b/Tools/docfx_project/articles/benchmarks/DataStructuresBenchmarks.md @@ -2,7 +2,7 @@ github repo -The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/master/Tools/Towel_Benchmarking). +The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/main/Tools/Towel_Benchmarking). ``` ini diff --git a/Tools/docfx_project/articles/benchmarks/HeapGenericsVsDelegatesBenchmarks.md b/Tools/docfx_project/articles/benchmarks/HeapGenericsVsDelegatesBenchmarks.md index d20ea101..6e6f344e 100644 --- a/Tools/docfx_project/articles/benchmarks/HeapGenericsVsDelegatesBenchmarks.md +++ b/Tools/docfx_project/articles/benchmarks/HeapGenericsVsDelegatesBenchmarks.md @@ -2,7 +2,7 @@ github repo -The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/master/Tools/Towel_Benchmarking). +The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/main/Tools/Towel_Benchmarking). ``` ini diff --git a/Tools/docfx_project/articles/benchmarks/MapVsDictionaryAddBenchmarks.md b/Tools/docfx_project/articles/benchmarks/MapVsDictionaryAddBenchmarks.md index d689b896..0c3e122f 100644 --- a/Tools/docfx_project/articles/benchmarks/MapVsDictionaryAddBenchmarks.md +++ b/Tools/docfx_project/articles/benchmarks/MapVsDictionaryAddBenchmarks.md @@ -2,7 +2,7 @@ github repo -The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/master/Tools/Towel_Benchmarking). +The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/main/Tools/Towel_Benchmarking). ``` ini diff --git a/Tools/docfx_project/articles/benchmarks/MapVsDictionaryLookUpBenchmarks.md b/Tools/docfx_project/articles/benchmarks/MapVsDictionaryLookUpBenchmarks.md index c1fdcd02..d89ec8a2 100644 --- a/Tools/docfx_project/articles/benchmarks/MapVsDictionaryLookUpBenchmarks.md +++ b/Tools/docfx_project/articles/benchmarks/MapVsDictionaryLookUpBenchmarks.md @@ -2,7 +2,7 @@ github repo -The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/master/Tools/Towel_Benchmarking). +The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/main/Tools/Towel_Benchmarking). ``` ini diff --git a/Tools/docfx_project/articles/benchmarks/PermuteBenchmarks.md b/Tools/docfx_project/articles/benchmarks/PermuteBenchmarks.md index a6d47272..3c8a72dc 100644 --- a/Tools/docfx_project/articles/benchmarks/PermuteBenchmarks.md +++ b/Tools/docfx_project/articles/benchmarks/PermuteBenchmarks.md @@ -2,7 +2,7 @@ github repo -The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/master/Tools/Towel_Benchmarking). +The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/main/Tools/Towel_Benchmarking). ``` ini diff --git a/Tools/docfx_project/articles/benchmarks/RandomBenchmarks.md b/Tools/docfx_project/articles/benchmarks/RandomBenchmarks.md index b017a14f..79b41276 100644 --- a/Tools/docfx_project/articles/benchmarks/RandomBenchmarks.md +++ b/Tools/docfx_project/articles/benchmarks/RandomBenchmarks.md @@ -2,7 +2,7 @@ github repo -The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/master/Tools/Towel_Benchmarking). +The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/main/Tools/Towel_Benchmarking). ``` ini diff --git a/Tools/docfx_project/articles/benchmarks/RandomWithExclusionsBenchmarks.md b/Tools/docfx_project/articles/benchmarks/RandomWithExclusionsBenchmarks.md index 1bf75c27..ddf163b4 100644 --- a/Tools/docfx_project/articles/benchmarks/RandomWithExclusionsBenchmarks.md +++ b/Tools/docfx_project/articles/benchmarks/RandomWithExclusionsBenchmarks.md @@ -2,7 +2,7 @@ github repo -The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/master/Tools/Towel_Benchmarking). +The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/main/Tools/Towel_Benchmarking). ``` ini diff --git a/Tools/docfx_project/articles/benchmarks/SortBenchmarks.md b/Tools/docfx_project/articles/benchmarks/SortBenchmarks.md index 6327e7f6..f33fdf92 100644 --- a/Tools/docfx_project/articles/benchmarks/SortBenchmarks.md +++ b/Tools/docfx_project/articles/benchmarks/SortBenchmarks.md @@ -2,7 +2,7 @@ github repo -The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/master/Tools/Towel_Benchmarking). +The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/main/Tools/Towel_Benchmarking). ``` ini diff --git a/Tools/docfx_project/articles/benchmarks/SpanVsArraySortingBenchmarks.md b/Tools/docfx_project/articles/benchmarks/SpanVsArraySortingBenchmarks.md index c00caf4f..30382dfd 100644 --- a/Tools/docfx_project/articles/benchmarks/SpanVsArraySortingBenchmarks.md +++ b/Tools/docfx_project/articles/benchmarks/SpanVsArraySortingBenchmarks.md @@ -2,7 +2,7 @@ github repo -The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/master/Tools/Towel_Benchmarking). +The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/main/Tools/Towel_Benchmarking). ``` ini diff --git a/Tools/docfx_project/articles/benchmarks/ToEnglishWordsBenchmarks.md b/Tools/docfx_project/articles/benchmarks/ToEnglishWordsBenchmarks.md index b7c07f4f..2e06a828 100644 --- a/Tools/docfx_project/articles/benchmarks/ToEnglishWordsBenchmarks.md +++ b/Tools/docfx_project/articles/benchmarks/ToEnglishWordsBenchmarks.md @@ -2,7 +2,7 @@ github repo -The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/master/Tools/Towel_Benchmarking). +The source code for all becnhmarks are in [Tools/Towel.Benchmarking](https://github.com/ZacharyPatten/Towel/tree/main/Tools/Towel_Benchmarking). ``` ini diff --git a/Tools/docfx_project/articles/intro.md b/Tools/docfx_project/articles/intro.md index 512a08eb..b04b0111 100644 --- a/Tools/docfx_project/articles/intro.md +++ b/Tools/docfx_project/articles/intro.md @@ -4,4 +4,4 @@ Browse the documentation articles. - + diff --git a/Tools/docfx_project/index.md b/Tools/docfx_project/index.md index c941e67a..4480aee9 100644 --- a/Tools/docfx_project/index.md +++ b/Tools/docfx_project/index.md @@ -4,4 +4,4 @@ This is the documentation website for Towel. - +