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
Apple iOS, iPadOS & macOS Clients For Meshtastic
2492 commits 36 branches 1 tag 78 MiB
Find a file
Garth Vander Houwen 42ff1e5658
Merge pull request #798 from meshtastic/document-magic-numbers 
Extract some magic numbers to named constants with some documentation
2024-07-17 00:39:42 -07:00
.github Add SwiftLint to CI checks 2024-06-28 12:08:55 -05:00
Meshtastic Merge pull request #798 from meshtastic/document-magic-numbers 2024-07-17 00:39:42 -07:00
Meshtastic.xcodeproj Node num details 2024-07-17 00:20:35 -07:00
Meshtastic.xcworkspace Weatherkit widgets 2024-07-11 08:42:27 -07:00
MeshtasticProtobufs update protos 2024-07-14 23:37:53 -07:00
protobufs@10494bf328 Node num details 2024-07-17 00:20:35 -07:00
scripts Adding scripts to setup linting as a pre-commit hook 2024-07-09 20:01:30 -05:00
Settings.bundle Simplify settings 2024-05-01 10:13:15 -07:00
Widgets Update image, remove unnesary version checks in widgets 2023-09-21 13:25:38 -07:00
.gitignore chore: add protobufs to git index 2024-02-21 00:44:00 -07:00
.gitmodules Add back submodule 2024-05-01 19:55:39 -07:00
.swiftlint.yml Extract the generated protobufs into its own Swift package 2024-06-28 11:11:01 -05:00
LICENSE Create LICENSE 2022-01-24 04:53:59 -08:00
Localizable.xcstrings High and low pressure 2024-07-12 11:38:06 -07:00
meshtastic-1080x1080.png Update readme 2022-11-19 11:12:40 -08:00
README.md Adding scripts to setup linting as a pre-commit hook 2024-07-09 20:01:30 -05:00

README.md

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:

  • run: 
    ./scripts/gen_protos.sh
  • build, test, commit changes

License

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