Merge branch 'release/0.9.0' into master

Author: ctreffs

CONTRIBUTING.md

@@ -0,0 +1,93 @@
+# 💁 Contributing to this project
+
+
+> First off, thank you for considering contributing to this project.   
+> It’s [people like you][ref-contributors] that keep this project alive and make it great!  
+> Thank you! 🙏💜🎉👍
+
+The following is a set of **guidelines for contributing** to this project. 
+Use your best judgment and feel free to propose changes to this document in a pull request.
+
+**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
+
+### 💡 Your contribution - the sky is the limit 🌈
+
+This is an open source project and we love to receive contributions from our community — [**you**][ref-contributors]!   
+
+There are many ways to contribute, from writing __tutorials__ or __blog posts__, improving the [__documentation__][ref-documentation], submitting __bug reports__ and __feature requests__ or 
+__writing code__ which can be incorporated into the repository itself.
+
+When contributing to this project, please feel free to discuss the change you wish to make via issue with the repository owners before making a change.
+
+<!--Note that we have a [code of conduct][ref-code-of-conduct], please follow it in all your interactions with the project.-->
+
+### 🐞 You want to report a bug or file an issue?
+
+1. Ensure that it was **not already reported** and is being worked on by checking [open issues][ref-issues].
+2. Create a [new issue][ref-issues-new] with a **clear and descriptive title**
+3. Write a **detailed comment** with as much relevant information as possible including
+ - *how to reproduce* the bug 
+ - a *code sample* or an *executable test case* demonstrating the expected behavior that is not occurring
+ - any *files that could help* trace it down (i.e. logs)
+  
+### 🩹 You wrote a patch that fixes an issue?
+
+1. Open a [new pull request (PR)][ref-pull-request-new] with the patch.
+2. Ensure the PR description clearly describes the problem and solution. 
+3. Link the relevant **issue** if applicable ([how to link issues in PRs][ref-pull-request-how-to]).
+4. Ensure that [**no tests are failing**][ref-gh-actions] and **coding conventions** are met
+5. Submit the patch and await review.
+
+### 🎁 You want to suggest or contribute a new feature?
+
+That's great, thank you! You rock 🤘 
+
+If you want to dive deep and help out with development on this project, then first get the project [installed locally][ref-readme]. 
+After that is done we suggest you have a look at tickets in our [issue tracker][ref-issues]. 
+You can start by looking through the beginner or help-wanted issues: 
+ - [__Good first issues__][ref-issues-first] are issues which should only require a few lines of code, and a test or two. 
+ - [__Help wanted issues__][ref-issues-help] are issues which should be a bit more involved than beginner issues. 
+These are meant to be a great way to get a smooth start and won't put you in front of the most complex parts of the system.
+
+If you are up to more challenging tasks with a bigger scope, then there are a set of tickets with a __feature__, __enhancement__ or __improvement__ tag. 
+These tickets have a general overview and description of the work required to finish. 
+If you want to start somewhere, this would be a good place to start. 
+That said, these aren't necessarily the easiest tickets. 
+
+For any new contributions please consider these guidelines:
+1. Open a [new pull request (PR)][ref-pull-request-new] with a **clear and descriptive title**
+2. Write a **detailed comment** with as much relevant information as possible including:
+ - What your feature is intended to do?
+ - How it can be used?
+ - What alternatives where considered?
+ - Has this feature impact on performance or stability of the project?
+
+#### Your contribution responsibilities
+
+Don't be intimidated by these responsibilities, they are easy to meet if you take your time to develop your feature 😌
+
+- [x] Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
+- [x] Ensure (cross-)platform compatibility for every change that's accepted. An addition should not reduce the number of platforms that the project supports.
+- [x] Ensure **coding conventions** are met. Lint your code with the project's default tools.
+- [x] Add tests for your feature that prove it's working as expected. Code coverage should not drop below its previous value.
+- [x] Ensure none of the existing tests are failing after adding your changes.
+- [x] Document your public API code and ensure to add code comments where necessary.
+
+
+### ⚙️ How to set up the environment
+
+Please consult the [README][ref-readme] for installation instructions.
+
+<!-- REFERENCES -->
+
+[ref-code-of-conduct]: t.b.d.
+[ref-contributors]: https://github.com/fireblade-engine/ecs/graphs/contributors
+[ref-documentation]: https://github.com/fireblade-engine/ecs/wiki
+[ref-gh-actions]: https://github.com/fireblade-engine/ecs/actions
+[ref-issues-first]: https://github.com/fireblade-engine/ecs/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue"
+[ref-issues-help]: https://github.com/fireblade-engine/ecs/issues?q=is%3Aopen+is%3Aissue+label%3A"help+wanted"
+[ref-issues-new]: https://github.com/fireblade-engine/ecs/issues/new/choose
+[ref-issues]: https://github.com/fireblade-engine/ecs/issues
+[ref-pull-request-how-to]: https://docs.github.com/en/github/writing-on-github/autolinked-references-and-urls
+[ref-pull-request-new]: https://github.com/fireblade-engine/ecs/compare
+[ref-readme]: https://github.com/fireblade-engine/ecs/blob/master/README.md

README.md

@@ -2,8 +2,70 @@
 
 [![license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE)
 [![github CI](https://github.com/fireblade-engine/math/workflows/CI/badge.svg)](https://github.com/fireblade-engine/math/actions?query=workflow%3ACI)
+[![swift version](https://img.shields.io/badge/swift-5.1+-blue.svg)](https://swift.org/download)
+[![platforms](https://img.shields.io/badge/platforms-%20macOS%20|%20iOS%20|%20tvOS%20-blue.svg)](#)
+[![platforms](https://img.shields.io/badge/platforms-linux-blue.svg)](#)
+[![platform-webassembly](https://img.shields.io/badge/Platform-WebAssembly-blue.svg)](https://github.com/swiftwasm/swift#swiftwasm)
 
-A dependency free, lightweight, fast math library for 2D and 3D vectors, quaternions and matrices in Swift with (optional) SIMD support.
+
+A dependency free, lightweight, fast math library for 2D and 3D vectors, quaternions and matrices in Swift with (optional) SIMD support.  It is developed and maintained as part of the [Fireblade Game Engine project](https://github.com/fireblade-engine).
+
+
+## 🚀 Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine and provide a code example.
+
+### 📋 Prerequisites
+
+* [Swift Package Manager (SPM)](https://github.com/apple/swift-package-manager)
+* [Swiftlint](https://github.com/realm/SwiftLint) for linting - (optional)
+* [SwiftEnv](https://swiftenv.fuller.li/) for Swift version management - (optional)
+
+### 💻 Installing
+
+Fireblade Math is available for all platforms that support [Swift 5.1](https://swift.org/) and higher and the [Swift Package Manager (SPM)](https://github.com/apple/swift-package-manager).
+
+Extend the following lines in your `Package.swift` file or use it to create a new project.
+
+```swift
+// swift-tools-version:5.1
+
+import PackageDescription
+
+let package = Package(
+    name: "YourPackageName",
+    dependencies: [
+        .package(url: "https://github.com/fireblade-engine/math.git", from: "0.9.0")
+    ],
+    targets: [
+        .target(
+            name: "YourTargetName",
+            dependencies: ["FirebladeMath"])
+    ]
+)
+
+```
+
+## 💁 How to contribute
+
+If you want to contribute please see the [CONTRIBUTION GUIDE](CONTRIBUTING.md) first. 
+
+To start your project contribution run these in your command line:
+
+1. `git clone [email protected]:fireblade-engine/math.git fireblade-math`
+2. `cd fireblade-math`
+3. `make setupEnvironment`
+
+Before commiting code please ensure to run:
+
+- `make precommit`
+
+This project is currently maintained by [@ctreffs](https://github.com/ctreffs).   
+See also the list of [contributors](https://github.com/fireblade-engine/math/contributors) who participated in this project.
+
+## 🔏 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
 
 ## ♻ Alternatives