Meshtastic-Apple/README.md
Garth Vander Houwen 374cb6dcd4
Update README.md
2022-11-16 18:43:50 -08:00

39 lines
737 B
Markdown

# Meshtastic Apple Clients
## Overview
SwiftUI client applicaitons for iOS, iPadOS and macOS.
## Stats
<!--Repobeats image here (avaliable when public)-->
## OS Requirements
* iOS App Requires iOS 16 +
* iPadOS App Requires iPadOS 16 +
* Mac App Reguires macOS 13 +
## Code Standards
- Use SwiftUI (Maps are the exception)
- Use Hierarchical icons
- Use Core Data for persistence
- Requires SwiftLint - see https://github.com/realm/SwiftLint
## To update protobufs:
- install swift-protobuf:
```bash
brew install swift-protobuf
```
- check out the latest protobuf commit from the master branch
- run:
```bash
./gen_proto.sh
```
- build, test, commit changes
- You may need to run:
```bash
swiftlint --fix
```