Update README.md

This commit is contained in:
Sacha Weatherstone 2022-05-12 21:22:10 +10:00 committed by GitHub
parent bc1992f8d3
commit 6351b0b71f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,5 +1,22 @@
# Meshtastic Apple Clients
[![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/Meshtastic-Apple)](https://cla-assistant.io/meshtastic/Meshtastic-Apple)
[![Fiscal Contributors](https://opencollective.com/meshtastic/tiers/badge.svg?label=Fiscal%20Contributors&color=deeppink)](https://opencollective.com/meshtastic/)
[![Vercel](https://img.shields.io/static/v1?label=Powered%20by&message=Vercel&style=flat&logo=vercel&color=000000)](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
```