generated from StanfordSpezi/SpeziTemplateApplication
-
-
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.
# Update the README ## ⚙️ Release Notes - Updates the README of the PAWS Repo ## 📝 Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/CS342/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/CS342/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/CS342/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/CS342/.github/blob/main/CONTRIBUTING.md).
- Loading branch information
1 parent
667cbe2
commit 6f4689f
Showing
1 changed file
with
28 additions
and
9 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,51 @@ | ||
<!-- | ||
This source file is part of the PAWS application based on the Stanford Spezi Template Application project | ||
This source file is part of the Pediatric Apple Watch Study Application based on the Stanford Spezi Template Application project | ||
SPDX-FileCopyrightText: 2023 Stanford University | ||
SPDX-License-Identifier: MIT | ||
--> | ||
|
||
# PAWS | ||
# Pediatric Apple Watch Study Application | ||
|
||
This repository contains the PAWS. | ||
The PAWS is using the [Spezi](https://github.com/StanfordSpezi/Spezi) ecosystem and builds on top of the [Stanford Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication). | ||
[![Beta Deployment](https://github.com/CS342/2023-PAWS/actions/workflows/beta-deployment.yml/badge.svg)](https://github.com/CS342/2023-PAWS/actions/workflows/beta-deployment.yml) | ||
[![codecov](https://codecov.io/gh/CS342/2023-PAWS/graph/badge.svg?token=0SNRhbC0wi)](https://codecov.io/gh/CS342/2023-PAWS) | ||
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10602852.svg)](https://doi.org/10.5281/zenodo.10602852) | ||
|
||
> [!NOTE] | ||
This repository contains the Pediatric Apple Watch Study Application application. | ||
The Pediatric Apple Watch Study Application is using the [Spezi](https://github.com/StanfordSpezi/Spezi) ecosystem and builds on top of the [Stanford Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication). | ||
|
||
|
||
## Application Structure | ||
|
||
The Spezi Template Application uses a modularized structure using the [Spezi modules](https://swiftpackageindex.com/StanfordSpezi) enabled by the Swift Package Manager. | ||
|
||
The application uses the FHIR standard to provide a shared standard to encode data exchanged between different modules. | ||
|
||
> [!NOTE] | ||
> Do you want to learn more about the Stanford Spezi Template Application and how to use, extend, and modify this application? Check out the [Stanford Spezi Template Application documentation](https://stanfordspezi.github.io/SpeziTemplateApplication) | ||
|
||
## PAWS Features | ||
## Build and Run the Application | ||
|
||
*Provide a comprehensive description of your application, including figures showing the application. You can learn more on how to structure a README in the [Stanford Spezi Documentation Guide](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/documentation-guide)* | ||
You can build and run the application using [Xcode](https://developer.apple.com/xcode/) by opening up the **PAWS.xcodeproj**. | ||
|
||
|
||
## Contributing | ||
|
||
*Ensure that you add an adequate contribution section to this README.* | ||
Contributions to this project are welcome. Please make sure to read the [contribution guidelines](https://github.com/StanfordBDHG/.github/blob/main/CONTRIBUTING.md) and the [contributor covenant code of conduct](https://github.com/StanfordBDHG/.github/blob/main/CODE_OF_CONDUCT.md) first. | ||
|
||
|
||
## License | ||
|
||
This project is licensed under the MIT License. See [Licenses](LICENSES) for more information. | ||
This project is licensed under the MIT License. See [Licenses](https://github.com/CS342/2023-PAWS/tree/main/LICENSES) for more information. | ||
|
||
|
||
## Our Research | ||
|
||
For more information, check out our website at [biodesigndigitalhealth.stanford.edu](https://biodesigndigitalhealth.stanford.edu). | ||
|
||
![Stanford Byers Center for Biodesign Logo](https://raw.githubusercontent.com/StanfordBDHG/.github/main/assets/biodesign-footer-light.png#gh-light-mode-only) | ||
![Stanford Byers Center for Biodesign Logo](https://raw.githubusercontent.com/StanfordBDHG/.github/main/assets/biodesign-footer-dark.png#gh-dark-mode-only) |