Skip to content

Commit

Permalink
Added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SommerEngineering committed Jan 12, 2020
1 parent 141b9a6 commit a9b122f
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit a9b122f

Please sign in to comment.