mirror of
https://github.com/meshtastic/Meshtastic-Apple.git
synced 2026-04-20 22:13:56 +00:00
Update README.md
This commit is contained in:
parent
bc1992f8d3
commit
6351b0b71f
1 changed files with 33 additions and 8 deletions
41
README.md
41
README.md
|
|
@ -1,5 +1,22 @@
|
|||
# Meshtastic Apple Clients
|
||||
|
||||
[](https://cla-assistant.io/meshtastic/Meshtastic-Apple)
|
||||
[](https://opencollective.com/meshtastic/)
|
||||
[](https://vercel.com?utm_source=meshtastic&utm_campaign=oss)
|
||||
|
||||
## Overview
|
||||
|
||||
A description about the project
|
||||
|
||||
**[Getting Started Guide](https://example.com)**
|
||||
|
||||
**[Documentation/API Reference](https://example.com)**
|
||||
|
||||
|
||||
## Stats
|
||||
|
||||
<!--Repobeats image here (avaliable when public)-->
|
||||
|
||||
## OS Requirements
|
||||
|
||||
* iOS App Requires iOS 15 +
|
||||
|
|
@ -8,16 +25,24 @@
|
|||
|
||||
## Code Standards
|
||||
|
||||
* Use SwiftUI
|
||||
* Use Hierarchical icons
|
||||
* Use Core Data for persistence
|
||||
|
||||
- Use SwiftUI
|
||||
- Use Hierarchical icons
|
||||
- Use Core Data for persistence
|
||||
- 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*
|
||||
- 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 *swiftlint --fix*
|
||||
- You may need to run:
|
||||
```bash
|
||||
swiftlint --fix
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue