Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build and packaging-related fixes #28

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Build and packaging-related fixes #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6597c07
Docs: add the contributor guide
ForNeVeR Feb 19, 2023
b27495b
Packaging: mention MIT in the license expression
ForNeVeR Feb 19, 2023
7ff5df8
Packaging: add more NuGet metadata
ForNeVeR Feb 19, 2023
b9054b8
Docs: add a link to nuget.org package
ForNeVeR Feb 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)
12 changes: 11 additions & 1 deletion src/FixedMath.NET/FixedMath.NET.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,19 @@

<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>

<Description>This library implements "Fix64", a 64 bit fixed point 31.32 numeric type and transcendent operations on it (square root, trig, etc).</Description>
<PackageLicenseExpression>Apache-2.0 AND MIT</PackageLicenseExpression>
<PackageProjectUrl>https://github.com/OpenSAGE/FixedMath.NET</PackageProjectUrl>
<RepositoryUrl>https://github.com/OpenSAGE/FixedMath.NET.git</RepositoryUrl>
<PackageTags>math;fixed-point</PackageTags>
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
<None Include="..\..\README.md" Pack="true" PackagePath="\" Visible="false" />
</ItemGroup>

<ItemGroup>
<!-- Note that this is not a "normal" ProjectReference.
It needs the additional 'OutputItemType' and 'ReferenceOutputAssmbly' attributes. -->
Expand Down