Jitouch

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 prerequisits and then follow the building steps below.

Prerequisites

1. Xcode (necessary)
   • Install Xcode from the Mac App Store
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)
   • brew install cocoapods
   • or follow the official instructions
4. pre-commit (recommended for contributors)
   • brew install pre-commit
   • or follow the official instructions
5. npm (required for release builds)
   • brew install npm
6. appdmg (required for release builds)
   • npm install -g appdmg

Building

1. Clone this repository:

   git clone https://github.com/JitouchProject/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.

4. Or compile from the shell:

   make build

5. Install and run:

   open DerivedData//Build/Products/Debug/Jitouch.prefPane

Contributing

1. Install the (optional) pre-commit hooks:

   pre-commit install

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

Deveoper 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

SPDX-License-Identifier: GPL-3.0-or-later

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