Skip to content

Updated README and added set-up instructions #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
angelinaa-chen merged 1 commit into from
Sep 12, 2025
Merged

Updated README and added set-up instructions #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
# score-ios
SCORE is a centralized sports information App for the Cornell community to discover and stay informed on athletic games.
# Score

Score aims to become the Cornell community’s go-to for all sports events information, with the following features (in order of implementation):
<p align="center"><img src="https://github.com/user-attachments/assets/d3025ab3-ce0b-4f83-852b-343627154fd8" width=150 /></p>

1. Centralized hub for sports game information discovery
Score is Cornell’s all-in-one sports discovery hub that makes Cornell sports easily accessible and engaging for the entire community. A free and open-source app, Score helps facilitate the seamless discovery, tracking, and engagement of Cornell sports, allowing students to conveniently stay informed on sports games and feel motivated to actively participate in the campus sports culture.

2. Real-time game status and score updates

3. Personalized game attendance planning
## Getting Started

(Taken from Notion, please update when finalized)
1. Clone the repository.
2. Download and uncompress the `ScoreSecrets/` folder, which AppDev members can find it pinned in the `#score-ios` Slack channel. Once done, drag the following folder into the root of the project through **FINDER (NOT Xcode)**. The folder should contain the following files:
- `GoogleService-Info.plist`
- `Keys.plist`
3. Build the project and you should be good to go! Select the `score-ios` schema to use our development server and `score-ios-prod` to use our production server.

## Common Issues

- If you're running into missing package errors, add the gameAPI folder as a package dependency. Go to File -> Add Package Dependencies -> Add Local -> select the folder
- The .zip folder can also found pinned in the `#score-ios` Slack channel.