Final read me (#82)

# *Updated 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 
*This PR adds a ReadME with documentation for users to take them through
our app

## 📚 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):
- [ ] 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).

CONTRIBUTORS.md

@@ -14,4 +14,9 @@ Intake Contributors
 * [Paul Schmiedmayer](https://github.com/PSchmiedmayer)
 * [Andreas Bauer](https://github.com/Supereg)
 * [Philipp Zagar](https://github.com/philippzagar)
-* [Nikolai Madlener](https://github.com/NikolaiMadlener)
+* [Nikolai Madlener](https://github.com/NikolaiMadlener)
+* [Akash Gupta](https://github.com/apgupta3303)
+* [Nick Riedman](https://github.com/nriedman)
+* [Zoya Garg](https://github.com/zoyagarg)
+* [Kate Callan](https://github.com/kcallon)
+* [Nina Boord](https://github.com/ninaboord)

Intake/Resources/Localizable.xcstrings

@@ -82,6 +82,9 @@
  },
  "Add_allergy" : {
 
+ },
+ "Add_allergy" : {
+
  },
  "ADD_REACTION" : {
 
@@ -260,6 +263,9 @@
  },
  "DELETE_SURGERY" : {
 
+ },
+ "Do you currently smoke or have you smoked in the past?" : {
+
  },
  "Download your medical records from your health system." : {
 

README.md

@@ -15,25 +15,38 @@ SPDX-License-Identifier: MIT
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10521599.svg)](https://doi.org/10.5281/zenodo.10521599)
 
 This repository contains the CS342 2024 Intake application.
-The CS342 2024 Intake 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).
+The CS342 2024 Intake 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). This app allows the user to manually fill out the form from scratch or connect their health records using HealthKit, in which case the form will be autofilled based on their health records.
 
 > [!NOTE] 
 > Do you want to try out the CS342 2024 Intake application? You can download it to your iOS device using [TestFlight](https://testflight.apple.com/join/Yp0Y24xT)!
 
 
 ## CS342 2024 Intake 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)*
+There are 8 main features in this app: Chief Complaint, Medical history, Surgical History, Medications, Allergiers, Menstrual History, Smoking History and Scrollable Summary. The chief complaint is described in greater detail below. The medical history feature autofills the users past and present conditions, denoting which of them are still active. The surgical history feature autofills the users past surgeries, with the corresponding date of the surgery. The medication feature is described in greater detail below. The allergies feature autofills the users allergies, along witht he reactions for each allergy. The menstrual history feature only displays if the user is a women and shows the start and end date of the users last period. The smoking history feature provides information about the users smoking habits. Finally, the scrollable summary is described in greater detail below.
 
-> [!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)
+The medical history, allergies, and surgeries all use [SpeziLLM](https://github.com/StanfordSpezi/SpeziLLM) to filter the data to only include the relevant information from the health records.
+
+The medical history, surgery, and allergy views all use [SpeziLLM](https://github.com/StanfordSpezi/SpeziLLM) to allow the user to click the chat button in the to and ask questions about that corresponding section, with an added ability to add entries to your form through the LLM chat.
+
+|![Screenshot displaying the chief complaint view.](screenshots/chiefComplaint.png#gh-light-mode-only) ![Screenshot displaying the chief complaint view.](screenshots/chiefComplaint.png#gh-dark-mode-only)|![Screenshot displaying the medication view.](screenshots/medication.png#gh-light-mode-only)![Screenshot displaying the medication view.](screenshots/medication.png#gh-dark-mode-only)|![Screenshot displaying the summary view.](screenshots/summary.png#gh-light-mode-only)![Screenshot displaying the summary view.](screenshots/summary.png#gh-dark-mode-only)
+|:--:|:--:|:--:|
+
+The image on the left is the chief complaint feature which uses [SpeziLLM](https://github.com/StanfordSpezi/SpeziLLM) to chat with the user about the reason for their visit. It asks specifically tailored questions based on the users response, and then forumalizes a chief complaint for the user once it has enough information to do so.
+
+The image in the middle is the medication feature which uses [SpeziMedication](https://github.com/StanfordSpezi/SpeziMedication) to gather all the necessary information about the medications the user is taking. It includes information about name of medication, dosgage, frequency, and schedule of taking the medicine. If you click the the + button in the top right, it will allow you to add a new medication. For this app, we have only allowed the user to choose between 10 medications, so that it can work with [SpeziMedication](https://github.com/StanfordSpezi/SpeziMedication), but the other features allow you enter any entry. 
+
+The image on the right is the summary page, which gives the user a summary for all the information it has gathered in the form. Any of the edit buttons will take the user back to that feature, so they can edit their information. This particular user did not have any surgeries, so it is left blank. The share button at the bottom allows the user to export this information into a pdf format that they can then send to their doctor. Additionally, once you share the form, it gets stored on the users phone, so the next time the user open the app, they have the ability to automatically load their most recent form and come straight to this page without having to go through the form again if nothing has changed.
 
 
 ## 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/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. You can find a list of contributors in the [Contributors.md](https://github.com/CS342/2024-Intake/blob/main/CONTRIBUTORS.md) file
 
 
 ## 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/StanfordSpezi/SpeziOnboarding/tree/main/LICENSES) for more information.
+
+![Spezi Footer](https://raw.githubusercontent.com/StanfordSpezi/.github/main/assets/FooterLight.png#gh-light-mode-only)
+![Spezi Footer](https://raw.githubusercontent.com/StanfordSpezi/.github/main/assets/FooterDark.png#gh-dark-mode-only)

screenshots/chiefComplaint.png.license

@@ -0,0 +1,5 @@
+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-License-Identifier: MIT

screenshots/medication.png.license

@@ -0,0 +1,5 @@
+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-License-Identifier: MIT

screenshots/summary.png.license

@@ -0,0 +1,5 @@
+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-License-Identifier: MIT