Contributing guide

Thank you for investing your time in contributing to LinearMouse!

Read our Code of Conduct to keep our community approachable and respectable.

Build instructions

Instructions for building LinearMouse on macOS.

Dependencies

Xcode, obviously
SwiftLint, used to lint Swift files
SwiftFormat, used to format Swift files
npm & ts-json-schema-generator, used to generate and document the custom configuration JSON scheme

Install tools using brew:

$ brew install npm swiftlint swiftformat

Install npm dependencies from the package.json

$ npm install

Setup the repository

$ git clone https://github.com/linearmouse/linearmouse.git
$ cd linearmouse

Configure code signing

Code signing is required by Apple. You can generate a code signing configuration by running

$ make configure

Note: If you want to contribute to LinearMouse, please don't modify the ‘Signing & Capabilities’ configurations directly in Xcode. Instead, use make configure or modify the Signing.xcconfig.

If there are no available code signing certificates in your Keychain, it will generate a configuration that uses ad-hoc certificates to sign the app.

By using ad-hoc certificates, you'll have to grant accessibility permissions for each builds. In that case, using Apple Development certificates is recommended. You can create an Apple Development certificate in Xcode, which is totally free.

Build

Now, you can build and package LinearMouse by running

$ make

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!