Skip to content

Commit

Permalink
Add overview to Readme (#76)
Browse files Browse the repository at this point in the history
# Add overview to Readme

## ♻️ Current situation & Problem
*Link any open issues or pull requests (PRs) related to this PR. Please
ensure that all non-trivial PRs are first tracked and discussed in an
existing GitHub issue or discussion.*


## ⚙️ Release Notes 
*Add a bullet point list summary of the feature and possible migration
guides if this is a breaking change so this section can be added to the
release notes.*
*Include code snippets that provide examples of the feature implemented
or links to the documentation if it appends or changes the public
interface.*


## 📚 Documentation
*Please ensure that you properly document any additions in conformance
to [Spezi Documentation
Guide](https://github.com/StanfordSpezi/.github/blob/main/DOCUMENTATIONGUIDE.md).*
*You can use this section to describe your solution, but we encourage
contributors to document your reasoning and changes using in-line
documentation.*


## ✅ Testing
*Please ensure that the PR meets the testing requirements set by CodeCov
and that new functionality is appropriately tested.*
*This section describes important information about the tests and why
some elements might not be testable.*


## 📝 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
menahassan authored Mar 15, 2024
1 parent fece558 commit c12caa6
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![image](https://github.com/CS342/2024-Stronger/assets/121056442/901a7d82-9c32-448a-8f5e-088d535356bf)<!--
<!--
This source file is part of the Stronger based on the Stanford Spezi Template Application project
Expand All @@ -19,6 +19,8 @@ The CS342 2024 Stronger application is using the [Spezi](https://github.com/Stan

> [!NOTE]
> Do you want to try out the CS342 2024 Stronger application? You can download it to your iOS device using [TestFlight](https://testflight.apple.com/join/7jyDe6Hm)!
## Overview
The CS342 Stronger Application provides a way to track protein intake and resistance exercise training in postmenopausal Stanford research participants. Participants can use Stronger to track these two critical behaviors by: Inputting progressive resistance training metrics, inputting their food intake, and viewing their progress compared to their custom workout and protein goals.


## CS342 2024 Stronger Features
Expand Down

0 comments on commit c12caa6

Please sign in to comment.