meshtastic/Meshtastic-Apple
1
0
Fork 0
mirror of https://github.com/meshtastic/Meshtastic-Apple.git synced 2026-04-20 22:13:56 +00:00
Code Issues Projects Releases Packages Wiki Activity
Meshtastic-Apple/README.md
Garth Vander Houwen 0d9745a296
Merge pull request #770 from meshtastic/release-management 
Adding project documentation to formalize development and release management
2024-08-01 18:31:45 -07:00

1.1 KiB
Raw Blame History

Meshtastic Apple Clients

Meshtastic App Store Launch Image

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

  • iOS 16+
  • iPadOS 16+
  • macOS 13+

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.