A Simplenote client for macOS. Learn more about Simplenote at Simplenote.com.
At the moment Simplenote for macOS uses Swift 5 and requires Xcode 12 or newer. Xcode can be downloaded from Apple.*
We use a few tools to help with development. To install or update the required dependencies, run the follow command on the command line:
rake dependencies
TL;DR We had issues with CocoaPods in the past and haven't had the bandwidth to upgrade to SwiftPM yet.
Back in the CocoaPods days, when we tried to fetch Sparkle using it, the version distributed via CocoaPods didn't support Sandboxing, an important feature in Simplenote macOS at the time.
To distribute the beta version of Simplenote with Sparkle, we used the 2.x branch.
See also this issue in the Sparkle repo.
Since then, Sparkle officially shipped their version 2, including SwiftPM support, but we haven't had a chance to upgrade yet.
If there'll be a need to work with Sparkle, ideally we should take the time to upgrade.
But just for reference, the process used so far to build from source is contained in the ./Scripts/update-sparkle.sh script.
We use SwiftLint to enforce a common style for Swift code. If you plan to write code, SwiftLint is going to be installed when you run a build from Xcode.
No commit should have lint warnings or errors.
Launch the project by running the following from the command line:
rake xcode
This will ensure any dependencies are ready before launching Xcode.
You can also open the project by double clicking on Simplenote.xcworkspace file, or launching Xcode and choose File > Open and browse to Simplenote.xcworkspace.
Simplenote is powered by the Simperium Sync'ing protocol. We distribute testing credentials that help us authenticate your application, and verify that the API calls being made are valid.
Please copy the testing Simperium credentials as follows:
mkdir -p Simplenote/Credentials && cp Simplenote/SPCredentials-demo.swift Simplenote/Credentials/SPCredentials.swift
This will allow you to compile and run the app on a device or a simulator.
Note: Simplenote API features such as sharing and publishing will not work with development builds.
We follow the WordPress iOS Style Guidelines, and we're constantly improving / adopting latest techniques.
Read our Contributing Guide to learn about reporting issues, contributing code, and more ways to contribute.
Simplenote for macOS is an Open Source project covered by the GNU General Public License version 2.
Happy noting!