generated from StanfordBDHG/SwiftPackageTemplate
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
# Initial Setup ## ⚙️ Release Notes - Updates the Setup with a minimal setup for a Spezi Module ### Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordBDHG/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordBDHG/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/StanfordBDHG/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordBDHG/.github/blob/main/CONTRIBUTING.md).
- Loading branch information
1 parent
5d59940
commit 4980e52
Showing
38 changed files
with
398 additions
and
766 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # | ||
| # This source file is part of the Stanford Spezi open source project | ||
| # | ||
| # SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md) | ||
| # | ||
| # SPDX-License-Identifier: MIT | ||
| # | ||
|
|
||
| name: Monthly Markdown Link Check | ||
|
|
||
| on: | ||
| # Runs at midnight on the first of every month | ||
| schedule: | ||
| - cron: "0 0 1 * *" | ||
|
|
||
| jobs: | ||
| markdown_link_check: | ||
| name: Markdown Link Check | ||
| uses: StanfordBDHG/.github/.github/workflows/markdown-link-check.yml@v2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,16 @@ | ||
| <!-- | ||
| # | ||
| # This source file is part of the TemplatePackage open source project | ||
| # This source file is part of the Stanford Spezi open source project | ||
| # | ||
| # SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md) | ||
| # SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md) | ||
| # | ||
| # SPDX-License-Identifier: MIT | ||
| # | ||
| --> | ||
|
|
||
| TemplatePackage contributors | ||
| SpeziSpeech contributors | ||
| ==================== | ||
|
|
||
| * [Paul Schmiedmayer](https://github.com/PSchmiedmayer) | ||
| * [Vishnu Ravi](https://github.com/vishnuravi) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1,79 @@ | ||
| <!-- | ||
| This source file is part of the TemplatePackage open source project | ||
| This source file is part of the Stanford Spezi open source project | ||
| SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md) | ||
| SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md) | ||
| SPDX-License-Identifier: MIT | ||
| --> | ||
|
|
||
| # TemplatePackage | ||
| # SpeziSpeech | ||
|
|
||
| [](https://github.com/StanfordBDHG/SwiftPackageTemplate/actions/workflows/build-and-test.yml) | ||
| [](https://codecov.io/gh/StanfordBDHG/SwiftPackageTemplate) | ||
| [](https://zenodo.org/badge/latestdoi/573230182) | ||
| [](https://swiftpackageindex.com/StanfordBDHG/SwiftPackageTemplate) | ||
| [](https://swiftpackageindex.com/StanfordBDHG/SwiftPackageTemplate) | ||
| [](https://github.com/StanfordSpezi/SpeziSpeech/actions/workflows/build-and-test.yml) | ||
| [](https://codecov.io/gh/StanfordSpezi/SpeziSpeech) | ||
|
|
||
|
|
||
| ## How To Use This Template | ||
| Enable applications to connect to Speech devices. | ||
|
|
||
| The template repository contains a template Swift Package, including a continuous integration setup. | ||
|
|
||
| Follow these steps to customize it to your needs: | ||
| 1. Rename the Swift Package. Be sure that you update the name in the `build-and-test.yml` GitHub Action accordingly. If you have multiple targets in your Swift Package, you need to pass the name of the Swift Package followed by an `-Package` as the scheme to the GitHub Action, e.g., `StanfordProject-Package` if your Swift Package is named `StanfordProject`. | ||
| 2. If your Swift Package does not provide any user interface or does not require an iOS application environment to function, you can remove the `UITests` application from the `Tests` folder. You need to update the `build-and-test.yml` GitHub Action accordingly by removing the GitHub Action that builds and tests the application, removing the dependency from the code coverage upload step, and removing the UI test `.xresult` input from the code coverage test. | ||
| 3. If your Swift Package uses UI test, you need to ... | ||
| - ... add it to the scheme editor (*Scheme > Edit Scheme*) and your targets to the "Build" configuration and ensure that it is built before the test app target when building for the "Test" configuration. It is not required to enable building for other configurations like "Analyze", "Run", "Profile", or "Archive". | ||
| - ... add it as a linked framework in the main target configuration (In your Xcode project settings, select your *test app target > General > Frameworks, Libraries, and Embedded Comments*). | ||
| - ... add ensure that the targets are all added in the code coverage settings of your .xctestplan file in the Xcode Project (*Shared Settings > Code Coverage > Code Coverage*). | ||
| 4. You will either need to add the [CodeCov GitHub App](https://github.com/apps/codecov) or add a codecov.io token to your [GitHub Actions Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-an-environment) following the instructions of the [Codecov GitHub Action](https://github.com/marketplace/actions/codecov#usage). The StanfordBDHG organization already has the [CodeCov GitHub App](https://github.com/apps/codecov) installed. If you do not want to cover test coverage data, you can remove the code coverage job in the `build-and-test.yml` GitHub Action. | ||
| 5. Adjust this README.md to describe your project and adjust the badges at the top to point to the correct GitHub Action of your repository and Codecov badge. | ||
| 6. The Swift Package template includes a Swift Package Index configuration file to automatically build the package and [host the documentation on the Swift Package Index website](https://blog.swiftpackageindex.com/posts/auto-generating-auto-hosting-and-auto-updating-docc-documentation/). Adjust the `.spi.yml` file to include all targets that you want to build documentation for. You can follow the [instructions of the Swift Package Index](https://swiftpackageindex.com/add-a-package) to include your Swift Package in the Swift Package Index. You can link to the [API documentation](https://swiftpackageindex.com/StanfordBDHG/SwiftPackageTemplate/documentation) from your README file. | ||
| 7. Adjust the CITATION.cff file to amend information about the new Swift Package ([learn more about CITATION files on GitHub](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files)) and [register the Swift Package on Zenodo](https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content). | ||
| ## Overview | ||
|
|
||
| ... | ||
|
|
||
| ## Installation | ||
|
|
||
| The project can be added to your Xcode project or Swift Package using the [Swift Package Manager](https://github.com/apple/swift-package-manager). | ||
| ## Setup | ||
|
|
||
| **Xcode:** For an Xcode project, follow the instructions on [adding package dependencies to your app](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app). | ||
|
|
||
| **Swift Package:** You can follow the [Swift Package Manager documentation about defining dependencies](https://github.com/apple/swift-package-manager/blob/main/Documentation/Usage.md#defining-dependencies) to add this project as a dependency to your Swift Package. | ||
| ### 1. Add Spezi Speech as a Dependency | ||
|
|
||
| You need to add the Spezi Speech Swift package to | ||
| [your app in Xcode](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app#) or | ||
| [Swift package](https://developer.apple.com/documentation/xcode/creating-a-standalone-swift-package-with-xcode#Add-a-dependency-on-another-Swift-package). | ||
|
|
||
| ## License | ||
| This project is licensed under the MIT License. See [Licenses](https://github.com/StanfordBDHG/TemplatePackage/tree/main/LICENSES) for more information. | ||
| > [!IMPORTANT] | ||
| > If your application is not yet configured to use Spezi, follow the [Spezi setup article](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/initial-setup) setup the core Spezi infrastructure. | ||
|
|
||
| ### 2. Register the Module | ||
|
|
||
| The `Speech` module needs to be registered in a Spezi-based application using the | ||
| [`configuration`](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/speziappdelegate/configuration) in a | ||
| [`SpeziAppDelegate`](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/speziappdelegate): | ||
| ```swift | ||
| class ExampleAppDelegate: SpeziAppDelegate { | ||
| override var configuration: Configuration { | ||
| Configuration { | ||
| Speech() | ||
| // ... | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| > [!NOTE] | ||
| > You can learn more about a [`Module` in the Spezi documentation](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/module). | ||
|
|
||
| ## Example | ||
|
|
||
| ... | ||
|
|
||
| ```swift | ||
| ... | ||
| ``` | ||
|
|
||
| For more information, please refer to the API documentation. | ||
|
|
||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions to this project are welcome. Please make sure to read the [contribution guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md) and the [contributor covenant code of conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) first. | ||
|
|
||
|
|
||
| ## License | ||
|
|
||
| ## Contributors | ||
| This project is developed as part of the Stanford Byers Center for Biodesign at Stanford University. | ||
| See [CONTRIBUTORS.md](https://github.com/StanfordBDHG/TemplatePackage/tree/main/CONTRIBUTORS.md) for a full list of all TemplatePackage contributors. | ||
| This project is licensed under the MIT License. See [Licenses](https://github.com/StanfordSpezi/SpeziContact/tree/main/LICENSES) for more information. | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| // | ||
| // This source file is part of the Stanford Spezi open-source project | ||
| // | ||
| // SPDX-FileCopyrightText: 2023 Stanford University | ||
| // | ||
| // SPDX-License-Identifier: MIT | ||
| // | ||
|
|
||
| "..." = "..."; |
Oops, something went wrong.