From 6597c07d0fd2fa39b1554bad8636ccb907bff81f Mon Sep 17 00:00:00 2001 From: Friedrich von Never Date: Sun, 19 Feb 2023 22:01:02 +0100 Subject: [PATCH 1/4] Docs: add the contributor guide --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ README.md | 4 ++++ 2 files changed, 29 insertions(+) create mode 100644 CONTRIBUTING.md 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..55cd619 100644 --- a/README.md +++ b/README.md @@ -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) From b27495ba9503209c064cd36d7ca5b9159a5948d8 Mon Sep 17 00:00:00 2001 From: Friedrich von Never Date: Sun, 19 Feb 2023 22:05:06 +0100 Subject: [PATCH 2/4] Packaging: mention MIT in the license expression This project seems to include portions of code under MIT, so formally any derived work has to follow the terms of both Apache 2 and MIT licenses. --- src/FixedMath.NET/FixedMath.NET.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/FixedMath.NET/FixedMath.NET.csproj b/src/FixedMath.NET/FixedMath.NET.csproj index ec0521d..aeb7578 100644 --- a/src/FixedMath.NET/FixedMath.NET.csproj +++ b/src/FixedMath.NET/FixedMath.NET.csproj @@ -2,7 +2,7 @@ netstandard2.0 - Apache-2.0 + Apache-2.0 AND MIT From 7ff5df87a20209069316e92eecb47073fd80cbae Mon Sep 17 00:00:00 2001 From: Friedrich von Never Date: Sun, 19 Feb 2023 22:12:07 +0100 Subject: [PATCH 3/4] Packaging: add more NuGet metadata --- src/FixedMath.NET/FixedMath.NET.csproj | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/FixedMath.NET/FixedMath.NET.csproj b/src/FixedMath.NET/FixedMath.NET.csproj index aeb7578..04073b3 100644 --- a/src/FixedMath.NET/FixedMath.NET.csproj +++ b/src/FixedMath.NET/FixedMath.NET.csproj @@ -2,9 +2,19 @@ netstandard2.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 + + + + From b9054b8c8e2f831a06ea4571433d28b8e3de80c4 Mon Sep 17 00:00:00 2001 From: Friedrich von Never Date: Sun, 19 Feb 2023 22:39:41 +0100 Subject: [PATCH 4/4] Docs: add a link to nuget.org package --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 55cd619..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