|
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647 |
- # WriteFreely SwiftUI MultiPlatform Client
-
- 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
-
- These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
-
- ### 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).
-
- - Xcode 12
- - [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.
-
- ## Running the tests
-
- To run the tests, select the scheme you want to test (iOS or macOS) and choose **Product** → **Test** from the Xcode menu.
-
- ## Contributing
-
- Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
-
- Need help getting started? Find out more about the project's [office hours](https://discuss.write.as/t/office-hours-for-writefreely-swift-projects/2788).
-
- ## Versioning
-
- We use [SemVer](https://semver.org/) for versioning and track changes in [CHANGELOG.md](CHANGELOG.md). For the versions available, see the
- [tags on this repository](https://github.com/writeas/writefreely-swiftui-multiplatform/tags).
-
- ## Authors
-
- - **Angelo Stavrow** - _Initial work_ - [AngeloStavrow](https://github.com/AngeloStavrow)
-
- See also the list of [contributors](https://github.com/writeas/writefreely-swiftui-multiplatform/contributors) who participated in this project.
-
- ## License
-
- This project is licensed under the GPL v3 License. See the [LICENSE.md](LICENSE.md) file for details.
|
