diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..9a7e3d6 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,17 @@ +All documentation, branch names, variable and method names, and comments must use American English. Pull request titles and commit messages must also be in English. +Do not create additional AGENTS.md files. +Do not use the `--no-build` parameter when running the application or tests, as it leads to missing libraries. +All tests should use xUnit with the FluentAssertions package. +Information about available concurrent collections and methods is documented in README.md. Additional methods are distributed across NuGet packages. +Before adding, modifying, or removing methods or classes, review the README files from related repositories. +Projects and tests must target .NET 8 by default and also support .NET 9, .NET 7, and .NET 6. Use the latest available C# language features when possible. + +## NuGet packages +- [Recyclable.Collections](https://www.nuget.org/packages/Recyclable.Collections) +- [Recyclable.Collections.Compatibility.List](https://www.nuget.org/packages/Recyclable.Collections.Compatibility.List) +- [Recyclable.Collections.Concurrent](https://www.nuget.org/packages/Recyclable.Collections.Concurrent) +- [Recyclable.Collections.Linq](https://www.nuget.org/packages/Recyclable.Collections.Linq) +- [Recyclable.Collections.Searching](https://www.nuget.org/packages/Recyclable.Collections.Searching) +- [Recyclable.Collections.TestData](https://www.nuget.org/packages/Recyclable.Collections.TestData) +- [Recyclable.Collections.TestData.xUnit](https://www.nuget.org/packages/Recyclable.Collections.TestData.xUnit) +- [Collections.Benchmarks.Core](https://www.nuget.org/packages/Collections.Benchmarks.Core) diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..478e3ae --- /dev/null +++ b/readme.md @@ -0,0 +1,14 @@ +# Recyclable.Collections.Concurrent +`Recyclable.Collections.Concurrent` project is an open source framework providing parallel operations using recyclable memory arrays. It aims at minimal memory footprint and the highest performance. + +## Available NuGet packages +- [Recyclable.Collections](https://www.nuget.org/packages/Recyclable.Collections) +- [Recyclable.Collections.Compatibility.List](https://www.nuget.org/packages/Recyclable.Collections.Compatibility.List) +- [Recyclable.Collections.Concurrent](https://www.nuget.org/packages/Recyclable.Collections.Concurrent) +- [Recyclable.Collections.TestData](https://www.nuget.org/packages/Recyclable.Collections.TestData) +- [Recyclable.Collections.TestData.xUnit](https://www.nuget.org/packages/Recyclable.Collections.TestData.xUnit) +- [Collections.Benchmarks.Core](https://www.nuget.org/packages/Collections.Benchmarks.Core) + +## Planned NuGet packages +- [Recyclable.Collections.Linq](https://www.nuget.org/packages/Recyclable.Collections.Linq) +- [Recyclable.Collections.Searching](https://www.nuget.org/packages/Recyclable.Collections.Searching)