Skip to content

Commit 2b172d0

Browse files
committed
chore: cleanup readme
- updated license and copyright
1 parent 7c658b5 commit 2b172d0

6 files changed

Lines changed: 91 additions & 69 deletions

File tree

.gitattributes

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# Declare files that will always have LF line endings on checkout.
55
*.sh text eol=lf
66

7-
# Don't check these into the repo as LF to work around TeamCity bug
7+
# Don't check these into the repo as LF normalization will mess with them.
88
*.xml -text
99
*.targets -text
1010

CONTRIBUTING.md

Lines changed: 17 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,25 @@
11
# Contributing
22

3-
When contributing to this repository, please first discuss the change you wish to make via issue,
4-
email, or any other method with the owners of this repository before making a change.
3+
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
54

65
Please note we have a code of conduct, please follow it in all your interactions with the project.
76

87
## Pull Request Process
98

10-
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
11-
build.
12-
2. Update the README.md with details of changes to the interface, this includes new environment
13-
variables, exposed ports, useful file locations and container parameters.
14-
3. Increase the version numbers in any examples files and the README.md to the new version that this
15-
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
16-
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
17-
do not have permission to do that, you may request the second reviewer to merge it for you.
9+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
10+
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
11+
3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
12+
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
1813

1914
## Code of Conduct
2015

2116
### Our Pledge
2217

23-
In the interest of fostering an open and welcoming environment, we as
24-
contributors and maintainers pledge to making participation in our project and
25-
our community a harassment-free experience for everyone, regardless of age, body
26-
size, disability, ethnicity, gender identity and expression, level of experience,
27-
nationality, personal appearance, race, religion, or sexual identity and
28-
orientation.
18+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
2919

3020
### Our Standards
3121

32-
Examples of behavior that contributes to creating a positive environment
33-
include:
22+
Examples of behavior that contributes to creating a positive environment include:
3423

3524
* Using welcoming and inclusive language
3625
* Being respectful of differing viewpoints and experiences
@@ -40,53 +29,31 @@ include:
4029

4130
Examples of unacceptable behavior by participants include:
4231

43-
* The use of sexualized language or imagery and unwelcome sexual attention or
44-
advances
32+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
4533
* Trolling, insulting/derogatory comments, and personal or political attacks
4634
* Public or private harassment
47-
* Publishing others' private information, such as a physical or electronic
48-
address, without explicit permission
49-
* Other conduct which could reasonably be considered inappropriate in a
50-
professional setting
35+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a professional setting
5137

5238
### Our Responsibilities
5339

54-
Project maintainers are responsible for clarifying the standards of acceptable
55-
behavior and are expected to take appropriate and fair corrective action in
56-
response to any instances of unacceptable behavior.
40+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
5741

58-
Project maintainers have the right and responsibility to remove, edit, or
59-
reject comments, commits, code, wiki edits, issues, and other contributions
60-
that are not aligned to this Code of Conduct, or to ban temporarily or
61-
permanently any contributor for other behaviors that they deem inappropriate,
62-
threatening, offensive, or harmful.
42+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
6343

6444
### Scope
6545

66-
This Code of Conduct applies both within project spaces and in public spaces
67-
when an individual is representing the project or its community. Examples of
68-
representing a project or community include using an official project e-mail
69-
address, posting via an official social media account, or acting as an appointed
70-
representative at an online or offline event. Representation of a project may be
71-
further defined and clarified by project maintainers.
46+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
7247

7348
### Enforcement
7449

75-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
76-
reported by contacting the project team at `david.oravsky@gmail.com`. All
77-
complaints will be reviewed and investigated and will result in a response that
78-
is deemed necessary and appropriate to the circumstances. The project team is
79-
obligated to maintain confidentiality with regard to the reporter of an incident.
80-
Further details of specific enforcement policies may be posted separately.
50+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at `david.oravsky@gmail.com`. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
8151

82-
Project maintainers who do not follow or enforce the Code of Conduct in good
83-
faith may face temporary or permanent repercussions as determined by other
84-
members of the project's leadership.
52+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
8553

8654
### Attribution
8755

88-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
89-
available at [http://contributor-covenant.org/version/1/4][version]
56+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
9057

9158
[homepage]: http://contributor-covenant.org
92-
[version]: http://contributor-covenant.org/version/1/4/
59+
[version]: http://contributor-covenant.org/version/1/4/

COPYRIGHT

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Copyright Information
2+
3+
Primary Author
4+
David Oravsky (mrdav30)
5+
2024–present
6+
7+
Contributors
8+
Additional contributors may be listed in the project's Git history.
9+
10+
Unless otherwise stated, all source code in this repository is
11+
copyright the author and licensed under the MIT License.

LICENSE.md renamed to LICENSE

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2024 mrdav30
3+
Copyright (c) 2024–present David Oravsky (mrdav30)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
21+
SOFTWARE.

NOTICE

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Additional Terms and Notices
2+
3+
Copyright (c) 2024–present David Oravsky (mrdav30)
4+
5+
1. Project Names and Branding
6+
7+
The names "FixedMathSharp"
8+
and related branding are the property of the original author.
9+
10+
These names may not be used to promote, endorse, or sell derived works
11+
without prior written permission from the author.
12+
13+
2. Redistribution
14+
15+
Redistribution of this software, whether modified or unmodified, must
16+
include the original LICENSE and NOTICE files.
17+
18+
3. Standalone Resale
19+
20+
This project may not be redistributed or sold as a standalone development
21+
toolkit, framework, or asset package without explicit permission from the
22+
author.
23+
24+
This restriction does not prevent use of the software as part of a larger
25+
application, game, engine, or commercial product.
26+
27+
4. Attribution
28+
29+
Derived works must retain attribution to the original project and author
30+
in documentation or repository history.

README.md

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
FixedMathSharp
1+
# FixedMathSharp
2+
23
==============
34

45
![FixedMathSharp Icon](https://raw.githubusercontent.com/mrdav30/fixedmathsharp/main/icon.png)
@@ -12,7 +13,7 @@ Ideal for simulations, games, and physics engines requiring reliable arithmetic
1213

1314
## 🛠️ Key Features
1415

15-
- **Deterministic Calculations:** Ensures consistent results across different platforms.
16+
- **Deterministic Calculations:** Ensures consistent results across different platforms.
1617
- **High Precision Arithmetic:** Uses fixed-point math to eliminate floating-point inaccuracies.
1718
- **Comprehensive Vector Support:** Includes 2D and 3D vector operations (`Vector2d`, `Vector3d`).
1819
- **Quaternion Rotations:** Leverage `FixedQuaternion` for smooth rotations without gimbal lock.
@@ -26,21 +27,20 @@ Ideal for simulations, games, and physics engines requiring reliable arithmetic
2627

2728
## 🚀 Installation
2829

29-
3030
Clone the repository and add it to your project:
3131

3232
### Non-Unity Projects
3333

3434
1. **Install via NuGet**:
3535
- Add FixedMathSharp to your project using the following command:
36-
36+
3737
```bash
3838
dotnet add package FixedMathSharp
3939
```
4040

4141
2. **Or Download/Clone**:
4242
- Clone the repository or download the source code.
43-
43+
4444
```bash
4545
git clone https://github.com/mrdav30/FixedMathSharp.git
4646
```
@@ -59,31 +59,35 @@ FixedMathSharp is now maintained as a separate Unity package.For Unity-specific
5959

6060
## 📖 Usage Examples
6161

62-
### Basic Arithmetic with `Fixed64`:
62+
### Basic Arithmetic with `Fixed64`
63+
6364
```csharp
6465
Fixed64 a = new Fixed64(1.5);
6566
Fixed64 b = new Fixed64(2.5);
6667
Fixed64 result = a + b;
6768
Console.WriteLine(result); // Output: 4.0
6869
```
6970

70-
### Vector Operations:
71+
### Vector Operations
72+
7173
```csharp
7274
Vector3d v1 = new Vector3d(1, 2, 3);
7375
Vector3d v2 = new Vector3d(4, 5, 6);
7476
Fixed64 dotProduct = Vector3d.Dot(v1, v2);
7577
Console.WriteLine(dotProduct); // Output: 32
7678
```
7779

78-
### Quaternion Rotation:
80+
### Quaternion Rotation
81+
7982
```csharp
8083
FixedQuaternion rotation = FixedQuaternion.FromAxisAngle(Vector3d.Up, FixedMath.PiOver2); // 90 degrees around Y-axis
8184
Vector3d point = new Vector3d(1, 0, 0);
8285
Vector3d rotatedPoint = rotation.Rotate(point);
8386
Console.WriteLine(rotatedPoint); // Output: (0, 0, -1)
8487
```
8588

86-
### Matrix Transformations:
89+
### Matrix Transformations
90+
8791
```csharp
8892
Fixed4x4 matrix = Fixed4x4.Identity;
8993
Vector3d position = new Vector3d(1, 2, 3);
@@ -92,14 +96,16 @@ Console.WriteLine(matrix);
9296
```
9397

9498
### Bounding Shapes and Intersection
99+
95100
```csharp
96101
BoundingBox box = new BoundingBox(new Vector3d(0, 0, 0), new Vector3d(5, 5, 5));
97102
BoundingSphere sphere = new BoundingSphere(new Vector3d(3, 3, 3), new Fixed64(1));
98103
bool intersects = box.Intersects(sphere);
99104
Console.WriteLine(intersects); // Output: True
100105
```
101106

102-
### Trigonometry Example:
107+
### Trigonometry Example
108+
103109
```csharp
104110
Fixed64 angle = FixedMath.PiOver4; // 45 degrees
105111
Fixed64 sinValue = FixedTrigonometry.Sin(angle);
@@ -148,14 +154,15 @@ int loot = rngOre.Next(1, 5); // [1,5)
148154
149155
### Fixed64 Struct
150156
151-
**Fixed64** is the core data type representing fixed-point numbers. It provides various mathematical operations, including addition, subtraction, multiplication, division, and more.
157+
**Fixed64** is the core data type representing fixed-point numbers. It provides various mathematical operations, including addition, subtraction, multiplication, division, and more.
152158
The struct guarantees deterministic behavior by using integer-based arithmetic with a configurable `SHIFT_AMOUNT`.
153159
154160
---
155161
156162
## ⚡ Performance Considerations
157163
158164
FixedMathSharp is optimized for high-performance deterministic calculations:
165+
159166
- **Inline methods and bit-shifting optimizations** ensure minimal overhead.
160167
- **Eliminates floating-point drift**, making it ideal for lockstep simulations.
161168
- **Supports fuzzy equality comparisons** for handling minor precision deviations.
@@ -164,10 +171,11 @@ FixedMathSharp is optimized for high-performance deterministic calculations:
164171
165172
## 🧪 Testing and Validation
166173
167-
Unit tests are used extensively to validate the correctness of mathematical operations.
174+
Unit tests are used extensively to validate the correctness of mathematical operations.
168175
Special **fuzzy comparisons** are employed where small precision discrepancies might occur, mimicking floating-point behavior.
169176
170177
To run the tests:
178+
171179
```bash
172180
dotnet test --configuration debug
173181
```
@@ -187,10 +195,6 @@ dotnet test --configuration debug
187195
188196
We welcome contributions! Please see our [CONTRIBUTING](https://github.com/mrdav30/FixedMathSharp/blob/main/CONTRIBUTING.md) guide for details on how to propose changes, report issues, and interact with the community.
189197
190-
## 📄 License
191-
192-
This project is licensed under the MIT License - see the [LICENSE](https://github.com/mrdav30/FixedMathSharp/blob/main/LICENSE.md) for details.
193-
194198
---
195199
196200
## 👥 Contributors
@@ -211,3 +215,13 @@ For bug reports or feature requests, please open an issue in this repository.
211215
We welcome feedback, contributors, and community discussion across all projects.
212216
213217
---
218+
219+
## License
220+
221+
This project is licensed under the MIT License.
222+
223+
See the following files for details:
224+
225+
- LICENSE – standard MIT license
226+
- NOTICE – additional terms regarding project branding and redistribution
227+
- COPYRIGHT – authorship information

0 commit comments

Comments
 (0)