From a9b122fde773b140f3e3814a3410cb6493f54ccd Mon Sep 17 00:00:00 2001 From: Thorsten Sommer Date: Sun, 12 Jan 2020 12:20:52 +0100 Subject: [PATCH] Added readme --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3566c97..ada844f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,11 @@ -# NoiseEngine -A noise engine implementation for .NET Core. +# About this library +This library implements noise generators. Currently only the cubic noise generator is implemented. In the future, however, further algorithms might be added as required. + +# .NET Core 3.1 LTS+ only +This library was implemented especially for .NET Core 3.1 and newer. It is therefore not available for .NET Standard 2.x or the outdated .NET Framework. This design decision was made based on the following background: (a) The .NET Framework will not be further developed (cf. https://devblogs.microsoft.com/dotnet/net-core-is-the-future-of-net/); (b) as of .NET 5.0, the .NET Standard is no longer expected to be required because Mono and the .NET Core will be merged together into the new .NET 5 (cf. https://devblogs.microsoft.com/dotnet/introducing-net-5/). + +# Acknowledgments +I thank Job Talle for his cubic noise algorithm. In [his article](https://jobtalle.com/cubic_noise.html) you can read more about the algorithm and its properties. My implementation is based on [the implementation of Job](https://github.com/jobtalle/CubicNoise). + +# License +This library uses the BSD 3-clause license. \ No newline at end of file