Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cypherpoet/swift-package-template
A starter template for Swift Package Manager projects.
https://github.com/cypherpoet/swift-package-template
github-templates hacktoberfest modular-code spm spm-templates swift swift-framework swift-package-manager swift-package-templates swift-world-domination templates xcode
Last synced: about 1 month ago
JSON representation
A starter template for Swift Package Manager projects.
- Host: GitHub
- URL: https://github.com/cypherpoet/swift-package-template
- Owner: CypherPoet
- License: mit
- Created: 2020-03-08T22:40:11.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-10-30T15:58:17.000Z (about 2 years ago)
- Last Synced: 2023-03-02T17:41:31.501Z (almost 2 years ago)
- Topics: github-templates, hacktoberfest, modular-code, spm, spm-templates, swift, swift-framework, swift-package-manager, swift-package-templates, swift-world-domination, templates, xcode
- Language: Swift
- Homepage:
- Size: 2.51 MB
- Stars: 16
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# MyLibraryName
[](https://swiftpackageindex.com/CypherPoet/MyLibraryName)
[](https://swiftpackageindex.com/CypherPoet/MyLibraryName)
_[ A brief synopsis of this library ]._
## Installation
### Xcode Projects
Select `File` -> `Swift Packages` -> `Add Package Dependency` and enter `https://github.com/CypherPoet/MyLibraryName`.
### Swift Package Manager Projects
You can add `MyPackageName` as a package dependency in your `Package.swift` file:
```swift
let package = Package(
//...
dependencies: [
.package(
url: "https://github.com/CypherPoet/MyLibraryName",
exact: "0.0.1"
),
],
//...
)
```
From there, refer to the `MyLibraryName` "product" delivered by the `MyPackageName` "package" inside of any of your project's target dependencies:
```swift
targets: [
.target(
name: "YourLibrary",
dependencies: [
.product(
name: "MyLibraryName",
package: "MyPackageName"
),
],
...
),
...
]
```
Then simply `import MyLibraryName` wherever you’d like to use it.
## Usage
## 🗺 Roadmap
- World Domination
## 💻 Developing
### Requirements
- Xcode 14.0+
### ✍️ Building The Documentation
Documentation is built with [DocC](https://developer.apple.com/documentation/docc) (see [Apple's guidance for more details about creating DocC content](https://developer.apple.com/documentation/docc/api-reference-syntax)).
To build and preview the documentation output, follow the instructions for the [here](https://github.com/apple/swift-docc-plugin#previewing-documentation) for the `Swift-DocC Plugin`.
If you're using VSCode, there's also a [task configuration](./.vscode/tasks.json) that will handle this directly from the editor 💪
## 🏷 License
`MyPackageName` is available under the MIT license. See the [LICENSE file](./LICENSE) for more info.
## Steps For Using This Template
- [ ] Rename instances of `MyLibraryName` to the library's product name.
- [ ] Rename files and directories with names of `MyLibraryName` to the library's product name.
- [ ] Rename instances of `MyPackageName` to the library's Swift package name.
- [ ] Update supported platforms in `Package.swift` and in this README's badges as appropriate.
- [ ] Replaces instances of `[ A brief synopsis of this library ]` with the library's short description.
- [ ] Delete this section.