Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.04 KB

README.md

File metadata and controls

49 lines (32 loc) · 1.04 KB
Raw

Meshtastic Apple Clients

Overview

SwiftUI client applications for iOS, iPadOS and macOS.

Getting Started

This project is currently using Xcode 15.4.

  1. Clone the repo.
  2. Set up git hooks to automatically lint the project when you commit changes.
  3. Open Meshtastic.xcworkspace
  4. Build and run the Meshtastic target.
git clone git@github.com:meshtastic/Meshtastic-Apple.git
cd Meshtastic-Apple
./scripts/setup-hooks.sh
open Meshtastic.xcworkspace

Technical Standards

Supported Operating Systems

The last two major operating system versions are supported on iOS, iPadOS and macOS.

Code Standards

  • Use SwiftUI
  • Use SFSymbols for icons
  • Use Core Data for persistence

Updating Protobufs:

  1. run
./scripts/gen_protos.sh
  1. Build, test, and commit the changes.

Release Process

For more information on how a new release of Meshtastic is managed, please refer to RELEASING.md

License

This project is licensed under the GPL v3. See the LICENSE file for details.