<commit_before># Firebase Sessions SDK

## Prerequisites

To update the Sessions Proto, Protobuf is required. To install run:

```
brew install protobuf
```

## Updating the Proto

 1. Follow the directions in `sessions.proto` for updating it
 1. Run the following to regenerate the nanopb source files: `./FirebaseSessions/ProtoSupport/generate_protos.sh`
 1. Update the SDK to use the new proto fields<commit_msg>[Sessions] Update README with development procedures (#10429)<commit_after># Firebase Sessions SDK

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

## Development
### Generating the Project and Test Project

 - `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.
 - `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.

### Debugging

### Command Line Arguments
You can access command line parameters by following: Press `CMD-Shift-,` => Run => Arguments.

 - `-FIRSessionsDebugEvents` will print Session Start events to the console for debugging purposes.

### Updating the Proto
#### Prerequesites
To update the Sessions Proto, Protobuf is required. To install run:

```
brew install protobuf
```

#### Procedure
 1. Follow the directions in `sessions.proto` for updating it
 1. Run the following to regenerate the nanopb source files: `./FirebaseSessions/ProtoSupport/generate_protos.sh`
 1. Update the SDK to use the new proto fields
{'fraction_non_alphanumeric': 0.08387477849970466, 'fraction_numerical': 0.006497341996455995, 'mean_word_length': 4.821305841924398, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6312953', 'n_tokens_mistral': 491, 'n_tokens_neox': 445, 'n_words': 200}