Skip to content
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.

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

Update README with xcodegen instructions #1733

Merged
merged 3 commits into from
Nov 25, 2023
Merged
Changes from all commits
Commits
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
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,30 @@ Ruuvi Station is an open-source iOS app [available](https://itunes.apple.com/us/

## How to use

1. Clone the repo with the recursive parameter ```git clone --recursive https://github.com/ruuvi/com.ruuvi.station.ios.git```
2. ```cd``` into repo and run: ```pod install --repo-update```
3. Open ```station.xcworkspace```
4. Configure Signing
Optional:
5. Obtain [OpenWeatherMap](https://openweathermap.org) API Key and put it into ```/station/Classes/Networking/Assembly/Networking.plist```
6. Setup your [Firebase](https://firebase.google.com) project and replace ```station/Resources/Plists/GoogleService-Info.plist```

Build and Run on your device!
1. Clone the repo with the recursive parameter
```zsh
git clone --recursive https://github.com/ruuvi/com.ruuvi.station.ios.git
cd com.ruuvi.station.ios
```

2. Make and open the `frameworks.xcodeproj`
```zsh
make
xed frameworks.xcodeproj
```

3. Configure Signing

4. Build and Run on your device!

<details>
<summary>Optionally</summary>

1. Obtain [OpenWeatherMap](https://openweathermap.org) API Key and put it into ```/station/Classes/Networking/Assembly/Networking.plist```

2. Setup your [Firebase](https://firebase.google.com) project and replace ```station/Resources/Plists/GoogleService-Info.plist```

</details>

## Get in touch

Expand Down