diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d964811 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +Contributor Guide +================= + +Build +----- + +> **Note** +> +> This project uses source generators that are not included into the solution file. This may cause problems if you build the project in IDE. +> +> If you experience any problems mentioning the `FixedMath.NET.Generators` assembly, run the following shell command before opening the project in the IDE: +> +> ```console +> $ dotnet build src/FixedMath.NET.Generators +> ``` +> +> (alternately, open said project in the IDE and build it from there) + +Before building the project in the IDE, remember to build the source generators: + +To build the project, run this shell command: + +``` +$ dotnet build +``` diff --git a/README.md b/README.md index 2b561ab..1531adf 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![CI](https://github.com/OpenSAGE/FixedMath.NET/actions/workflows/ci.yml/badge.svg)](https://github.com/OpenSAGE/FixedMath.NET/actions/workflows/ci.yml) [![codecov](https://codecov.io/gh/OpenSAGE/FixedMath.NET/branch/master/graph/badge.svg?token=LZO8MJT5HA)](https://codecov.io/gh/OpenSAGE/FixedMath.NET) -![Nuget](https://img.shields.io/nuget/v/fixedmath.net) +[![Nuget](https://img.shields.io/nuget/v/fixedmath.net)](https://www.nuget.org/packages/FixedMath.NET) ## Changes @@ -18,3 +18,7 @@ In the unit tests you'll find implementations for Int32-based (Q15.16) and Byte- This project started as a port of libfixmath (http://code.google.com/p/libfixmath/). Note that the type requires explicit casts to convert to floating point and this is intentional, the difference between fixed point and floating point math is as important as the one between floating point and integral math. + +## Documentation + +- [Contributor Guide](CONTRIBUTING.md) diff --git a/src/FixedMath.NET/FixedMath.NET.csproj b/src/FixedMath.NET/FixedMath.NET.csproj index ec0521d..04073b3 100644 --- a/src/FixedMath.NET/FixedMath.NET.csproj +++ b/src/FixedMath.NET/FixedMath.NET.csproj @@ -2,9 +2,19 @@ netstandard2.0 - Apache-2.0 + + This library implements "Fix64", a 64 bit fixed point 31.32 numeric type and transcendent operations on it (square root, trig, etc). + Apache-2.0 AND MIT + https://github.com/OpenSAGE/FixedMath.NET + https://github.com/OpenSAGE/FixedMath.NET.git + math;fixed-point + README.md + + + +