writefreely/swiftui-multiplatform
2
0
Fork 0
mirror of https://github.com/writeas/writefreely-swiftui-multiplatform.git synced 2024-11-15 01:11:02 +00:00
Code Issues Releases Wiki Activity

Update README for latest info

Browse Source
This commit is contained in:
Angelo Stavrow 2020-10-20 15:47:06 -04:00 committed by GitHub
parent 22109a47d7
commit 055caae5ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -2,15 +2,21 @@
A multiplatform (iOS, iPadOS, and macOS) client for [WriteFreely](https://writefreely.org/), built in SwiftUI. A multiplatform (iOS, iPadOS, and macOS) client for [WriteFreely](https://writefreely.org/), built in SwiftUI.
## How To Get The Apps
The iOS app is now [available on the App Store](https://apps.apple.com/us/app/writefreely/id1531530896) for iPhones and iPads running iOS 14. Check out [this help forum topic](https://discuss.write.as/t/using-the-writefreely-ios-app/1946) for a guide on using the app.
The Mac app is still under development.
## Getting Started ## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites ### Prerequisites
⚠️ Building and testing the iOS targets will work on any version of macOS that supports Xcode 12, but building and testing the macOS target requires macOS 11 (Big Sur) beta 5. ⚠️ Building and testing the iOS targets will work on any version of macOS that supports Xcode 12, but building and testing the macOS target requires macOS 11 (Big Sur) beta 9.
- Xcode 12 beta 5 - Xcode 12
- [SwiftLint](https://github.com/realm/SwiftLint) - [SwiftLint](https://github.com/realm/SwiftLint)
SwiftLint is run as a build phase for all targets, so that linting warnings and errors are shown in Xcode. SwiftLint is run as a build phase for all targets, so that linting warnings and errors are shown in Xcode.
@ -21,7 +27,7 @@ To run the tests, select the scheme you want to test (iOS or macOS) and choose *
## Contributing ## Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us. Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning ## Versioning