Skip to content

Commit 6597c07

Browse files
committed
Docs: add the contributor guide
1 parent 3fb5ac8 commit 6597c07

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Contributor Guide
2+
=================
3+
4+
Build
5+
-----
6+
7+
> **Note**
8+
>
9+
> This project uses source generators that are not included into the solution file. This may cause problems if you build the project in IDE.
10+
>
11+
> If you experience any problems mentioning the `FixedMath.NET.Generators` assembly, run the following shell command before opening the project in the IDE:
12+
>
13+
> ```console
14+
> $ dotnet build src/FixedMath.NET.Generators
15+
> ```
16+
>
17+
> (alternately, open said project in the IDE and build it from there)
18+
19+
Before building the project in the IDE, remember to build the source generators:
20+
21+
To build the project, run this shell command:
22+
23+
```
24+
$ dotnet build
25+
```

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,7 @@ In the unit tests you'll find implementations for Int32-based (Q15.16) and Byte-
1818
This project started as a port of libfixmath (http://code.google.com/p/libfixmath/).
1919

2020
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.
21+
22+
## Documentation
23+
24+
- [Contributor Guide](CONTRIBUTING.md)

0 commit comments

Comments
 (0)