From 6351b0b71f17b5e1abc86251e2052307c8f8a01e Mon Sep 17 00:00:00 2001 From: Sacha Weatherstone Date: Thu, 12 May 2022 21:22:10 +1000 Subject: [PATCH] Update README.md --- README.md | 41 +++++++++++++++++++++++++++++++++-------- 1 file changed, 33 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 95dbbbd5..b60b43ca 100644 --- a/README.md +++ b/README.md @@ -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 + + + ## 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 + ```