Skip to content

Commit 3fb0f10

Browse files
committed
Update README
1 parent f1a97e4 commit 3fb0f10

1 file changed

Lines changed: 63 additions & 1 deletion

File tree

README.md

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,70 @@
22

33
[![license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE)
44
[![github CI](https://github.com/fireblade-engine/math/workflows/CI/badge.svg)](https://github.com/fireblade-engine/math/actions?query=workflow%3ACI)
5+
[![swift version](https://img.shields.io/badge/swift-5.1+-blue.svg)](https://swift.org/download)
6+
[![platforms](https://img.shields.io/badge/platforms-%20macOS%20|%20iOS%20|%20tvOS%20-blue.svg)](#)
7+
[![platforms](https://img.shields.io/badge/platforms-linux-blue.svg)](#)
8+
[![platform-webassembly](https://img.shields.io/badge/Platform-WebAssembly-blue.svg)](https://github.com/swiftwasm/swift#swiftwasm)
59

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
769

870
## ♻ Alternatives
971

0 commit comments

Comments
 (0)