/writefreely-swiftui-multiplatform

Source code for the WriteFreely SwiftUI app for iOS, iPadOS, and macOS

Primary LanguageSwiftGNU General Public License v3.0GPL-3.0

WriteFreely SwiftUI MultiPlatform Client

A multiplatform (iOS, iPadOS, and macOS) client for WriteFreely, built in SwiftUI.

How To Get The Apps

The iOS app is now available on the App Store for iPhones and iPads running iOS 14. Check out this help forum topic 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).

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 ProductTest from the Xcode menu.

Contributing

Please read 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.

Versioning

We use SemVer for versioning and track changes in CHANGELOG.md. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the GPL v3 License. See the LICENSE.md file for details.