Crazor / Jitouch-project

A multi-touch extension for MacBook, Magic Mouse, and Magic Trackpad

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Jitouch

macOS 10.9+ Apple Silicon ready License GPL3 CI

Jitouch is a Mac application that expands the set of multi-touch gestures for MacBook, Magic Mouse, and Magic Trackpad. These thoughtfully designed gestures enable users to perform frequent tasks more easily such as changing tabs in web browsers, closing windows, minimizing windows, changing spaces, and a lot more.

For more details, see https://www.jitouch.com/.

Hacking

To build or modify Jitouch, please install the necessary prerequisites and then follow the building steps below.

Prerequisites

  1. Xcode (necessary)
  2. Homebrew (recommended):
    • Follow the official instructions
    • or run /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  3. CocoaPods (necessary)
  4. npm (required for release builds)
    • brew install npm
  5. appdmg (required for release builds)
    • npm install -g appdmg

Building

  1. Clone this repository:
    git clone https://github.com/JitouchApp/Jitouch
    cd Jitouch
  2. Install the dependencies:
    pod install
  3. Either open the project in Xcode:
    open Jitouch.xcworkspace
❗ Please note that you must not open Jitouch.xcodeproj, otherwise CocoaPods dependencies will not be built correctly.
  1. Or compile from the shell:
    make build
  2. Install and run:
    open DerivedData/Build/Products/Debug/Jitouch.prefPane

Contributing

  1. Fork this project, commit your changes and open a pull-request
❗ You need to sign-off your commits to acknowledge the Developer Certificate of Origin (DCO).

This will be enforced automatically on pull requests. For more information, read about the DCO App and the following section.

Developer Certificate of Origin (DCO)

To sign-off on a commit, read the DCO and then add the -s flag to git commit:

-s, --signoff
    Add Signed-off-by line by the committer at the end of the commit log
    message. The meaning of a signoff depends on the project, but it typically
    certifies that committer has the rights to submit this work under the same
    license and agrees to a Developer Certificate of Origin (see
    http://developercertificate.org/ for more information).

License

Jitouch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Jitouch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Jitouch. If not, see https://www.gnu.org/licenses/.

About

A multi-touch extension for MacBook, Magic Mouse, and Magic Trackpad

License:GNU General Public License v3.0


Languages

Language:Objective-C 99.6%Language:Makefile 0.1%Language:HTML 0.1%Language:Ruby 0.1%