From 91b72c16edafc74eaa711de99d034bbea1bbca38 Mon Sep 17 00:00:00 2001 From: CMK Date: Tue, 29 Mar 2022 18:49:28 +0800 Subject: [PATCH] chore: update README --- Documentation/Acknowledgments.md | 34 +++++++++++++ README.md | 85 ++++---------------------------- 2 files changed, 44 insertions(+), 75 deletions(-) create mode 100644 Documentation/Acknowledgments.md diff --git a/Documentation/Acknowledgments.md b/Documentation/Acknowledgments.md new file mode 100644 index 000000000..eab4b93f5 --- /dev/null +++ b/Documentation/Acknowledgments.md @@ -0,0 +1,34 @@ +# Acknowledgments + +- [AlamofireImage](https://github.com/Alamofire/AlamofireImage) +- [AlamofireNetworkActivityIndicator](https://github.com/Alamofire/AlamofireNetworkActivityIndicator) +- [Alamofire](https://github.com/Alamofire/Alamofire) +- [CommonOSLog](https://github.com/mainasuk/CommonOSLog) +- [CryptoSwift](https://github.com/krzyzanowskim/CryptoSwift) +- [DateToolSwift](https://github.com/MatthewYork/DateTools) +- [DiffableDataSources](https://github.com/ra1028/DiffableDataSources) +- [DifferenceKit](https://github.com/ra1028/DifferenceKit) +- [FLAnimatedImage](https://github.com/Flipboard/FLAnimatedImage) +- [FLEX](https://github.com/FLEXTool/FLEX) +- [FPSIndicator](https://github.com/MainasuK/FPSIndicator) +- [Fuzi](https://github.com/cezheng/Fuzi) +- [Kanna](https://github.com/tid-kijyun/Kanna) +- [KeychainAccess](https://github.com/kishikawakatsumi/KeychainAccess.git) +- [Kingfisher](https://github.com/onevcat/Kingfisher) +- [MetaTextKit](https://github.com/TwidereProject/MetaTextKit) +- [Nuke-FLAnimatedImage-Plugin](https://github.com/kean/Nuke-FLAnimatedImage-Plugin) +- [Nuke](https://github.com/kean/Nuke) +- [Pageboy](https://github.com/uias/Pageboy#the-basics) +- [PanModal](https://github.com/slackhq/PanModal.git) +- [SDWebImage](https://github.com/SDWebImage/SDWebImage) +- [swift-collections](https://github.com/apple/swift-collections) +- [swift-nio](https://github.com/apple/swift-nio) +- [SwiftGen](https://github.com/SwiftGen/SwiftGen) +- [SwiftUI-Introspect](https://github.com/siteline/SwiftUI-Introspect) +- [SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON) +- [Tabman](https://github.com/uias/Tabman) +- [TwidereX-iOS](https://github.com/TwidereProject/TwidereX-iOS) +- [ThirdPartyMailer](https://github.com/vtourraine/ThirdPartyMailer) +- [TOCropViewController](https://github.com/TimOliver/TOCropViewController) +- [TwitterProfile](https://github.com/OfTheWolf/TwitterProfile) +- [UITextView-Placeholder](https://github.com/devxoul/UITextView-Placeholder) \ No newline at end of file diff --git a/README.md b/README.md index aac90354a..bf35b4599 100644 --- a/README.md +++ b/README.md @@ -4,85 +4,20 @@ Download on the App Store -## Requirements +## Introduction -- Xcode 12.5+ -- Swift 5.3+ -- iOS 14.0+ +This is the repository for the official iOS App for Mastodon. You can install it from the App Store now. You can build the app from source and file bug report here. -## Setup -We need the latest version of Xcode from App Store. And use Cocoapods for dependency management. +Read this blog post for this app to learn more. +> [Developing an official iOS app for Mastodon](https://blog.joinmastodon.org/2021/02/developing-an-official-ios-app-for-mastodon/) -### CocoaPods +## Getting Start +- Read the setup guide [here](./Documentation/Setup.md) +- About [contributing](./Documentation/CONTRIBUTING.md) +- [Documentation folder](./Documentation/) -#### For the Intel Mac - -```zsh -sudo gem install cocoapods -sudo gem install cocoapods-keys -pod install -``` - -#### For the M1 Mac - -```zsh -sudo gem install cocoapods -sudo gem install cocoapods-keys - -# pod install may not works on M1 Mac. Fix by install ffi -# ref: https://github.com/CocoaPods/CocoaPods/issues/10220 -sudo arch -x86_64 gem install ffi - -arch -x86_64 pod install -``` - -## Start - -1. Open `Mastodon.xcworkspace` -2. Wait the Swift Package Dependencies resolved. -2. Check the signing settings make sure choose a team. [More info…](https://help.apple.com/xcode/mac/current/#/dev23aab79b4) -3. Select `Mastodon` scheme and run it. - -#### Contributors -The app require the `App Group` capability. To make sure it works for your developer membership. Please check [AppSecret.swift](AppShared/AppSecret.swift) file and set another unique `groupID` and update `App Group` settings. - -The app is compatible with [toot-relay](https://github.com/DagAgren/toot-relay) APNs. You can set your push notification endpoint via cocoapod-keys. - - -## Acknowledgements - -- [AlamofireImage](https://github.com/Alamofire/AlamofireImage) -- [AlamofireNetworkActivityIndicator](https://github.com/Alamofire/AlamofireNetworkActivityIndicator) -- [Alamofire](https://github.com/Alamofire/Alamofire) -- [CommonOSLog](https://github.com/mainasuk/CommonOSLog) -- [CryptoSwift](https://github.com/krzyzanowskim/CryptoSwift) -- [DateToolSwift](https://github.com/MatthewYork/DateTools) -- [DiffableDataSources](https://github.com/ra1028/DiffableDataSources) -- [DifferenceKit](https://github.com/ra1028/DifferenceKit) -- [FLAnimatedImage](https://github.com/Flipboard/FLAnimatedImage) -- [FLEX](https://github.com/FLEXTool/FLEX) -- [FPSIndicator](https://github.com/MainasuK/FPSIndicator) -- [Fuzi](https://github.com/cezheng/Fuzi) -- [Kanna](https://github.com/tid-kijyun/Kanna) -- [KeychainAccess](https://github.com/kishikawakatsumi/KeychainAccess.git) -- [Kingfisher](https://github.com/onevcat/Kingfisher) -- [MetaTextKit](https://github.com/TwidereProject/MetaTextKit) -- [Nuke-FLAnimatedImage-Plugin](https://github.com/kean/Nuke-FLAnimatedImage-Plugin) -- [Nuke](https://github.com/kean/Nuke) -- [Pageboy](https://github.com/uias/Pageboy#the-basics) -- [PanModal](https://github.com/slackhq/PanModal.git) -- [SDWebImage](https://github.com/SDWebImage/SDWebImage) -- [swift-collections](https://github.com/apple/swift-collections) -- [swift-nio](https://github.com/apple/swift-nio) -- [SwiftGen](https://github.com/SwiftGen/SwiftGen) -- [SwiftUI-Introspect](https://github.com/siteline/SwiftUI-Introspect) -- [SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON) -- [Tabman](https://github.com/uias/Tabman) -- [TwidereX-iOS](https://github.com/TwidereProject/TwidereX-iOS) -- [ThirdPartyMailer](https://github.com/vtourraine/ThirdPartyMailer) -- [TOCropViewController](https://github.com/TimOliver/TOCropViewController) -- [TwitterProfile](https://github.com/OfTheWolf/TwitterProfile) -- [UITextView-Placeholder](https://github.com/devxoul/UITextView-Placeholder) +## Acknowledgments +Thanks to these open-sources projects listed [here](./Documentation/Acknowledgments.md). ## License