Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Automattic/simplenote-macos

Simplenote for macOS
https://github.com/Automattic/simplenote-macos

Last synced: about 2 months ago
JSON representation

Simplenote for macOS

Lists

README 

        
# Simplenote for macOS



![Screenshot](https://simplenoteblog.files.wordpress.com/2021/09/gh-screenshot.png)



A Simplenote client for macOS. Learn more about Simplenote at [Simplenote.com](https://simplenote.com).



## Build Instructions



### Download Xcode



At the moment *Simplenote for macOS* uses Swift 5 and requires Xcode 12 or newer. Xcode can be [downloaded from Apple](https://developer.apple.com/downloads/index.action).*



### Third party tools



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`



#### CocoaPods



Simplenote for iOS uses [CocoaPods](http://cocoapods.org/) to manage third party libraries.

Third party libraries and resources managed by CocoaPods will be installed by the `rake dependencies` command above.



#### Why isn't Sparkle fetched with CocoaPods



At the time of writing, the version of Sparkle distributed via CocoaPods doesn't support Sandboxing, a feature that we value in Simplenote macOS.



To distribute the beta version of Simplenote with Sparkle, we need to use the [`2.x`](https://github.com/sparkle-project/Sparkle/tree/2.x) branch.

This new version has been in the works for quite some time and you can keep track of process to get it shipped [on this issue in the Sparkle repo](https://github.com/sparkle-project/Sparkle/issues/1523).



In the meantime, we need to manually clone the branch, build the framework and copy it in our repo.

Hopefully, you won't need to update Sparkle till version 2.x has shipped but, in case you do, this process is automated via the `./Scripts/update-sparkle.sh` script.



#### SwiftLint



We use [SwiftLint](https://github.com/realm/SwiftLint) to enforce a common style for Swift code. The app should build and work without it, but if you plan to write code, you are encouraged to install it. No commit should have lint warnings or errors.



You can set up a Git [pre-commit hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) to run SwiftLint automatically when committing by running:



`rake git:install_hooks`



This is the recommended way to include SwiftLint in your workflow, as it catches lint issues locally before your code makes its way to Github.



Alternately, a SwiftLint scheme is exposed within the project; Xcode will show a warning if you don't have SwiftLint installed.



Finally, you can also run SwiftLint manually from the command line with:



`rake lint`



If your code has any style violations, you can try to automatically correct them by running:



`rake lint:autocorrect`



Otherwise you have to fix them manually.



### Open Xcode



Launch the workspace 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`.



## Setup Credentials



Simplenote is powered by the [Simperium Sync'ing protocol](https://www.simperium.com). We distribute **testing credentials** that help us authenticate your application, and verify that the API calls being made are valid.



**⚠️ Please note → We're not accepting any new Simperium accounts at this time.**



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._



## Style Guidelines



 We follow the WordPress iOS Style Guidelines, and we're constantly improving / adopting latest techniques.



 - [Swift Standard](https://github.com/wordpress-mobile/swift-style-guide)

 - [ObjC Standard](https://github.com/wordpress-mobile/objective-c-style-guide)



## Contributing



Read our [Contributing Guide](CONTRIBUTING.md) to learn about reporting issues, contributing code, and more ways to contribute.



## License



Simplenote for macOS is an Open Source project covered by the [GNU General Public License version 2](LICENSE.md).



Happy noting!