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

49 lines
887 B
Markdown
Raw Normal View History

Update README.md
2022-01-24 17:36:38 -08:00
# Meshtastic Apple Clients
add swiftlint; tune errors to warnings for now
2021-11-29 15:57:24 -08:00
Update readme
2022-11-19 11:12:40 -08:00
<a href="https://apple.co/3Auysep">
<img alt="Meshtastic App Store Launch Image" src="meshtastic-1080x1080.png" />
</a>
Update README.md
2022-05-12 21:22:10 +10:00
## Overview
fix typo in README
2024-02-03 21:28:36 +00:00
SwiftUI client applications for iOS, iPadOS and macOS.
Update README.md
2022-05-12 21:22:10 +10:00
General Project Cleanup * Change SwiftLint from a "Run Script" build phase to a "Run Build Tool Plugins" build phase. * Developers no longer need to install and update SwiftLint manually. This can be useful when other projects are using different versions of SwiftLint. * [SwiftLint Docs](https://github.com/realm/SwiftLint?tab=readme-ov-file#xcode-projects) * [WWDC 22 - Meet Swift Package Plugins](https://developer.apple.com/videos/play/wwdc2022/110359/?time=162) * Moved several scripts into a `.scripts` directory to keep the project root organized. * Modified `.scripts/gen_protos.sh` to intelligently update git submodules and install `swift-protobuf` when it detects issues, reducing developer friction. * Deleted the empty unit and UI testing targets. These can be added later as we write tests. someday 🙏 * Updated the README.md to reflect the above changes, and organized a few of the sections.
2024-06-03 19:05:58 -05:00
## Getting Started
Update README.md
2021-12-25 23:52:20 -08:00
General Project Cleanup * Change SwiftLint from a "Run Script" build phase to a "Run Build Tool Plugins" build phase. * Developers no longer need to install and update SwiftLint manually. This can be useful when other projects are using different versions of SwiftLint. * [SwiftLint Docs](https://github.com/realm/SwiftLint?tab=readme-ov-file#xcode-projects) * [WWDC 22 - Meet Swift Package Plugins](https://developer.apple.com/videos/play/wwdc2022/110359/?time=162) * Moved several scripts into a `.scripts` directory to keep the project root organized. * Modified `.scripts/gen_protos.sh` to intelligently update git submodules and install `swift-protobuf` when it detects issues, reducing developer friction. * Deleted the empty unit and UI testing targets. These can be added later as we write tests. someday 🙏 * Updated the README.md to reflect the above changes, and organized a few of the sections.
2024-06-03 19:05:58 -05:00
This project is currently using **Xcode 15.4**.
Update README.md
2021-12-25 23:52:20 -08:00
General Project Cleanup * Change SwiftLint from a "Run Script" build phase to a "Run Build Tool Plugins" build phase. * Developers no longer need to install and update SwiftLint manually. This can be useful when other projects are using different versions of SwiftLint. * [SwiftLint Docs](https://github.com/realm/SwiftLint?tab=readme-ov-file#xcode-projects) * [WWDC 22 - Meet Swift Package Plugins](https://developer.apple.com/videos/play/wwdc2022/110359/?time=162) * Moved several scripts into a `.scripts` directory to keep the project root organized. * Modified `.scripts/gen_protos.sh` to intelligently update git submodules and install `swift-protobuf` when it detects issues, reducing developer friction. * Deleted the empty unit and UI testing targets. These can be added later as we write tests. someday 🙏 * Updated the README.md to reflect the above changes, and organized a few of the sections.
2024-06-03 19:05:58 -05:00
1. Clone the repo.
2. Open `Meshtastic.xcodeproj`
2. Build and run the `Meshtastic` target.
Update README.md
2021-12-25 23:52:20 -08:00
General Project Cleanup * Change SwiftLint from a "Run Script" build phase to a "Run Build Tool Plugins" build phase. * Developers no longer need to install and update SwiftLint manually. This can be useful when other projects are using different versions of SwiftLint. * [SwiftLint Docs](https://github.com/realm/SwiftLint?tab=readme-ov-file#xcode-projects) * [WWDC 22 - Meet Swift Package Plugins](https://developer.apple.com/videos/play/wwdc2022/110359/?time=162) * Moved several scripts into a `.scripts` directory to keep the project root organized. * Modified `.scripts/gen_protos.sh` to intelligently update git submodules and install `swift-protobuf` when it detects issues, reducing developer friction. * Deleted the empty unit and UI testing targets. These can be added later as we write tests. someday 🙏 * Updated the README.md to reflect the above changes, and organized a few of the sections.
2024-06-03 19:05:58 -05:00
```sh
git clone git@github.com:meshtastic/Meshtastic-Apple.git
cd Meshtastic-Apple
open Meshtastic.xcodeproj
```
update protobufs from master 0de53c84a26a42ce9405109e392ca1143de86f58
2021-11-29 21:11:27 -08:00
General Project Cleanup * Change SwiftLint from a "Run Script" build phase to a "Run Build Tool Plugins" build phase. * Developers no longer need to install and update SwiftLint manually. This can be useful when other projects are using different versions of SwiftLint. * [SwiftLint Docs](https://github.com/realm/SwiftLint?tab=readme-ov-file#xcode-projects) * [WWDC 22 - Meet Swift Package Plugins](https://developer.apple.com/videos/play/wwdc2022/110359/?time=162) * Moved several scripts into a `.scripts` directory to keep the project root organized. * Modified `.scripts/gen_protos.sh` to intelligently update git submodules and install `swift-protobuf` when it detects issues, reducing developer friction. * Deleted the empty unit and UI testing targets. These can be added later as we write tests. someday 🙏 * Updated the README.md to reflect the above changes, and organized a few of the sections.
2024-06-03 19:05:58 -05:00
## Technical Standards
update protobufs from master 0de53c84a26a42ce9405109e392ca1143de86f58
2021-11-29 21:11:27 -08:00
General Project Cleanup * Change SwiftLint from a "Run Script" build phase to a "Run Build Tool Plugins" build phase. * Developers no longer need to install and update SwiftLint manually. This can be useful when other projects are using different versions of SwiftLint. * [SwiftLint Docs](https://github.com/realm/SwiftLint?tab=readme-ov-file#xcode-projects) * [WWDC 22 - Meet Swift Package Plugins](https://developer.apple.com/videos/play/wwdc2022/110359/?time=162) * Moved several scripts into a `.scripts` directory to keep the project root organized. * Modified `.scripts/gen_protos.sh` to intelligently update git submodules and install `swift-protobuf` when it detects issues, reducing developer friction. * Deleted the empty unit and UI testing targets. These can be added later as we write tests. someday 🙏 * Updated the README.md to reflect the above changes, and organized a few of the sections.
2024-06-03 19:05:58 -05:00
### Supported Operating Systems
* iOS 16+
* iPadOS 16+
* macOS 13+
### Code Standards
- Use SwiftUI
- Use SFSymbols for icons
- Use Core Data for persistence
## Updating Protobufs:
Update README.md
2022-05-12 21:22:10 +10:00
- run:
```bash
General Project Cleanup * Change SwiftLint from a "Run Script" build phase to a "Run Build Tool Plugins" build phase. * Developers no longer need to install and update SwiftLint manually. This can be useful when other projects are using different versions of SwiftLint. * [SwiftLint Docs](https://github.com/realm/SwiftLint?tab=readme-ov-file#xcode-projects) * [WWDC 22 - Meet Swift Package Plugins](https://developer.apple.com/videos/play/wwdc2022/110359/?time=162) * Moved several scripts into a `.scripts` directory to keep the project root organized. * Modified `.scripts/gen_protos.sh` to intelligently update git submodules and install `swift-protobuf` when it detects issues, reducing developer friction. * Deleted the empty unit and UI testing targets. These can be added later as we write tests. someday 🙏 * Updated the README.md to reflect the above changes, and organized a few of the sections.
2024-06-03 19:05:58 -05:00
.scripts/gen_protos.sh
Update README.md
2022-05-12 21:22:10 +10:00
```
update protobufs from master 0de53c84a26a42ce9405109e392ca1143de86f58
2021-11-29 21:11:27 -08:00
- build, test, commit changes
General Project Cleanup * Change SwiftLint from a "Run Script" build phase to a "Run Build Tool Plugins" build phase. * Developers no longer need to install and update SwiftLint manually. This can be useful when other projects are using different versions of SwiftLint. * [SwiftLint Docs](https://github.com/realm/SwiftLint?tab=readme-ov-file#xcode-projects) * [WWDC 22 - Meet Swift Package Plugins](https://developer.apple.com/videos/play/wwdc2022/110359/?time=162) * Moved several scripts into a `.scripts` directory to keep the project root organized. * Modified `.scripts/gen_protos.sh` to intelligently update git submodules and install `swift-protobuf` when it detects issues, reducing developer friction. * Deleted the empty unit and UI testing targets. These can be added later as we write tests. someday 🙏 * Updated the README.md to reflect the above changes, and organized a few of the sections.
2024-06-03 19:05:58 -05:00
## License
This project is licensed under the GPL v3. See the [LICENSE](LICENSE) file for details.
Reference in a new issue Copy permalink