Documentation ReadMe

[czhang771]

ReadMe

♻️ Current situation & Problem

Would love it if everyone can read the assignment for documentation and add their sections in the README and proof read it.

⚙️ Release Notes

Sections that still need to be done

• Features (each person describe your feature)
• Photos (upload your photo in the Resource folder in the project, not the one in PICS, which should only contain screenshots and update the readme
• Contributions: everyone add their contributions (should be pretty similar to pdf)
• Setup: I think Andreas said something about including firebase stuff?

📚 Documentation

✅ Testing

📝 Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

• I agree to follow the Code of Conduct and Contributing Guidelines.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.06%. Comparing base (35e98bf) to head (c12a8a8).

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #60      +/-   ##
==========================================
- Coverage   86.21%   83.06%   -3.14%     
==========================================
  Files          54       54              
  Lines        2987     2987              
==========================================
- Hits         2575     2481      -94     
- Misses        412      506      +94     

see 4 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 35e98bf...c12a8a8. Read the comment docs.

[YurenSUN]

Yeah we finally made it!