Meshtastic-Apple/README.md

24 lines
638 B
Markdown
Raw Normal View History

2022-01-24 17:36:38 -08:00
# Meshtastic Apple Clients
2021-12-25 23:52:20 -08:00
## OS Requirements
2022-01-24 17:36:38 -08:00
* iOS App Requires iOS 15 +
2022-01-24 18:23:12 -08:00
* iPadOS App Requires iPadOS 15 +
2022-01-24 17:36:38 -08:00
* Mac App Reguires macOS 12 +
2021-12-25 23:52:20 -08:00
2021-12-25 23:52:50 -08:00
## Code Standards
2021-12-25 23:52:20 -08:00
2022-02-23 19:22:48 -10:00
* Use SwiftUI
2021-12-25 23:52:20 -08:00
* Use Hierarchical icons
2022-01-24 17:20:36 -08:00
* Use Core Data for persistence
2021-12-25 23:52:20 -08:00
- Requires SwiftLint - see https://github.com/realm/SwiftLint
## To update protobufs:
- install swift-protobuf: *brew install swift-protobuf*
- check out the latest commit from master branch from here: https://github.com/meshtastic/Meshtastic-protobufs in a directory that is at the same level as this project
- run: *./gen_proto.sh*
- build, test, commit changes
- You may need to run *swiftlint --fix*