|
2 | 2 |
|
3 | 3 | [](LICENSE) |
4 | 4 | [](https://github.com/fireblade-engine/math/actions?query=workflow%3ACI) |
| 5 | +[](https://swift.org/download) |
| 6 | +[](#) |
| 7 | +[](#) |
| 8 | +[](https://github.com/swiftwasm/swift#swiftwasm) |
5 | 9 |
|
6 | | -A dependency free, lightweight, fast math library for 2D and 3D vectors, quaternions and matrices in Swift with (optional) SIMD support. |
| 10 | + |
| 11 | +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). |
| 12 | + |
| 13 | + |
| 14 | +## 🚀 Getting Started |
| 15 | + |
| 16 | +These instructions will get you a copy of the project up and running on your local machine and provide a code example. |
| 17 | + |
| 18 | +### 📋 Prerequisites |
| 19 | + |
| 20 | +* [Swift Package Manager (SPM)](https://github.com/apple/swift-package-manager) |
| 21 | +* [Swiftlint](https://github.com/realm/SwiftLint) for linting - (optional) |
| 22 | +* [SwiftEnv](https://swiftenv.fuller.li/) for Swift version management - (optional) |
| 23 | + |
| 24 | +### 💻 Installing |
| 25 | + |
| 26 | +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). |
| 27 | + |
| 28 | +Extend the following lines in your `Package.swift` file or use it to create a new project. |
| 29 | + |
| 30 | +```swift |
| 31 | +// swift-tools-version:5.1 |
| 32 | + |
| 33 | +import PackageDescription |
| 34 | + |
| 35 | +let package = Package( |
| 36 | + name: "YourPackageName", |
| 37 | + dependencies: [ |
| 38 | + .package(url: "https://github.com/fireblade-engine/math.git", from: "0.9.0") |
| 39 | + ], |
| 40 | + targets: [ |
| 41 | + .target( |
| 42 | + name: "YourTargetName", |
| 43 | + dependencies: ["FirebladeMath"]) |
| 44 | + ] |
| 45 | +) |
| 46 | + |
| 47 | +``` |
| 48 | + |
| 49 | +## 💁 How to contribute |
| 50 | + |
| 51 | +If you want to contribute please see the [CONTRIBUTION GUIDE](CONTRIBUTING.md) first. |
| 52 | + |
| 53 | +To start your project contribution run these in your command line: |
| 54 | + |
| 55 | +1. `git clone git@github.com:fireblade-engine/math.git fireblade-math` |
| 56 | +2. `cd fireblade-math` |
| 57 | +3. `make setupEnvironment` |
| 58 | + |
| 59 | +Before commiting code please ensure to run: |
| 60 | + |
| 61 | +- `make precommit` |
| 62 | + |
| 63 | +This project is currently maintained by [@ctreffs](https://github.com/ctreffs). |
| 64 | +See also the list of [contributors](https://github.com/fireblade-engine/math/contributors) who participated in this project. |
| 65 | + |
| 66 | +## 🔏 License |
| 67 | + |
| 68 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details |
7 | 69 |
|
8 | 70 | ## ♻ Alternatives |
9 | 71 |
|
|
0 commit comments