Skip to content

Commit

Permalink
Update README & CodeCov Setup (#7)
Browse files Browse the repository at this point in the history
# Update README & CodeCov Setup

## ♻️ Current situation & Problem
- The README provides little visual information to understand the
project


## ⚙️ Release Notes 
- Adds badges to the README
- Adds a TestFlight download link to the README
- Fixes the CodeCov Setup


## 📚 Documentation
- Improves the README


## ✅ Testing
- No code changes, does not require any tests


## 📝 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
PSchmiedmayer authored Jan 17, 2024
1 parent 365126e commit 1d168bf
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 46 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,26 @@ SPDX-License-Identifier: MIT
-->

# Behavior
# CS342 2024 PRISMA

This repository contains the Behavior.
The Behavior 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).
[![Build and Test](https://github.com/CS342/2024-Behavior/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/CS342/2024-Behavior/actions/workflows/build-and-test.yml)
[![codecov](https://codecov.io/gh/CS342/2024-Behavior/graph/badge.svg?token=Kl2PgPHuci)](https://codecov.io/gh/CS342/2024-Behavior)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10521597.svg)](https://doi.org/10.5281/zenodo.10521597)

> [!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)
This repository contains the CS342 2024 PRISMA application.
The CS342 2024 PRISMA 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).

> [!NOTE]
> Do you want to try out the CS342 2024 PRISMA application? You can download it to your iOS device using [TestFlight](https://testflight.apple.com/join/bPu7kUoM)!

## Behavior Features
## CS342 2024 PRISMA Features

*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)*

> [!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)

## Contributing

Expand Down
40 changes: 0 additions & 40 deletions codecov.yml

This file was deleted.

0 comments on commit 1d168bf

Please sign in to comment.