Skip to content

Commit 5c8577c

Browse files
authored
Update README with project details and installation guide
Added project description and installation instructions for Swift Package Manager and Xcode.
1 parent cf145fe commit 5c8577c

1 file changed

Lines changed: 33 additions & 1 deletion

File tree

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,36 @@
11
### OpenSpatial
22
[![codecov](https://codecov.io/github/helbertgs/OpenSpatial/graph/badge.svg?token=7WrVJPx17w)](https://codecov.io/github/helbertgs/OpenSpatial)
33
![Language](https://img.shields.io/badge/Swift-6.1-orange.svg)
4-
[![Swift](https://github.com/helbertgs/OpenSpatial/actions/workflows/swift.yml/badge.svg)](https://github.com/helbertgs/OpenSpatial/actions/workflows/swift.yml)
4+
[![Swift](https://github.com/helbertgs/OpenSpatial/actions/workflows/swift.yml/badge.svg)](https://github.com/helbertgs/OpenSpatial/actions/workflows/swift.yml)
5+
6+
Open-source implementation of Apple's [Spatial](https://developer.apple.com/documentation/spatial) framework to Create and manipulate 3D mathematical primitives.
7+
8+
The main goal of this project is to provide a compatible, reliable and efficient implementation which can be used on Apple's operating systems before iOS 16.0, iPadOS 16.0, macOS 13.0, tvOS 16.0, watchOS 9.0, as well as Linux, Windows and WebAssembly.
9+
10+
### Installation
11+
##### Swift Package Manager
12+
To add `OpenSpatial` to your [SwiftPM](https://swift.org/package-manager/) package, add the `OpenSpatial` package to the list of package and target dependencies in your `Package.swift` file.
13+
14+
```swift
15+
dependencies: [
16+
.package(url: "https://github.com/helbertgs/OpenSpatial.git", branch: "main")
17+
],
18+
targets: [
19+
.target(
20+
name: "MyAwesomePackage",
21+
dependencies: [
22+
.product(name: "OpenSpatial", package: "OpenSpatial")
23+
]
24+
),
25+
]
26+
```
27+
28+
###### Xcode
29+
`OpenSpatial` can also be added as a SwiftPM dependency directly in your Xcode project *(requires Xcode 11 upwards)*.
30+
31+
To do so, open Xcode, use **File****Swift Packages****Add Package Dependency…**, enter the [repository URL](https://github.com/helbertgs/OpenSpatial.git), choose the latest available version, and activate the checkboxes:
32+
33+
<p align="center">
34+
<img alt="Select the OpenSpatial target"
35+
src="" width="70%">
36+
</p>

0 commit comments

Comments
 (0)