diff --git a/README.md b/README.md index 7dcb338db..948ddf48a 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,43 @@ ## Requirements +- Xcode 12.4+ +- Swift 5.3+ +- iOS 14.0+ + ## Setup +We needs the latest version Xcode from App Store. And install Cocoapods for dependency management. -### Setup for M1 Mac +### CocoaPods -CocoaPods may fail to update. Try install fii to fix it. +#### For the Intel Mac ```zsh -# https://github.com/CocoaPods/CocoaPods/issues/10220 +# install cocoapods from Homebrew +brew install cocoapods +pod install +``` + +#### For the M1 Mac + +```zsh +# install cocoapods from Homebrew +brew install cocoapods + +# 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. + ## Acknowledgements