Meshtastic-Apple/README.md

40 lines
799 B
Markdown
Raw Normal View History

2022-01-24 17:36:38 -08:00
# Meshtastic Apple Clients
2022-11-19 11:12:40 -08:00
<a href="https://apple.co/3Auysep">
<img alt="Meshtastic App Store Launch Image" src="meshtastic-1080x1080.png" />
</a>
2022-05-12 21:22:10 +10:00
## Overview
2022-10-08 08:49:12 -07:00
SwiftUI client applicaitons for iOS, iPadOS and macOS.
2022-05-12 21:22:10 +10:00
2021-12-25 23:52:20 -08:00
## OS Requirements
2022-10-08 08:49:12 -07:00
* iOS App Requires iOS 16 +
* iPadOS App Requires iPadOS 16 +
* Mac App Reguires macOS 13 +
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-11-11 17:13:47 -08:00
- Use SwiftUI (Maps are the exception)
2022-05-12 21:22:10 +10:00
- Use Hierarchical icons
- Use Core Data for persistence
- Requires SwiftLint - see https://github.com/realm/SwiftLint
## To update protobufs:
2022-05-12 21:22:10 +10:00
- 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
2022-05-12 21:22:10 +10:00
- You may need to run:
```bash
swiftlint --fix
```