Skip to content

Commit c7386ca

Browse files
authored
[Sessions] Update README with development procedures (#10429)
1 parent 9876601 commit c7386ca

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

FirebaseSessions/README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,30 @@
11
# Firebase Sessions SDK
22

33
## Prerequisites
4+
Follow the [Main Firebase Readme](https://github.com/firebase/firebase-ios-sdk#development)
45

6+
## Development
7+
### Generating the Project and Test Project
8+
9+
- `generate_project.sh` uses [cocoapods-generate](https://github.com/square/cocoapods-generate) to create an Xcode Workspace that has the SDK installed for all the SDK's supported platforms. This is useful for test-based development.
10+
- `generate_testapp.sh` generates and opens a test app with the Sessions SDK included. This is useful for developing the Sessions SDK against a real app.
11+
12+
### Debugging
13+
14+
### Command Line Arguments
15+
You can access command line parameters by following: Press `CMD-Shift-,` => Run => Arguments.
16+
17+
- `-FIRSessionsDebugEvents` will print Session Start events to the console for debugging purposes.
18+
19+
### Updating the Proto
20+
#### Prerequesites
521
To update the Sessions Proto, Protobuf is required. To install run:
622

723
```
824
brew install protobuf
925
```
1026

11-
## Updating the Proto
12-
27+
#### Procedure
1328
1. Follow the directions in `sessions.proto` for updating it
1429
1. Run the following to regenerate the nanopb source files: `./FirebaseSessions/ProtoSupport/generate_protos.sh`
1530
1. Update the SDK to use the new proto fields

0 commit comments

Comments
 (0)