comfortable-swipe/README.md
Rico Tiongson 8b8b7aca5b Update README
Prefer markdown table instead of sample image for instructions. Add 'command not found' alternative command.
2017-11-07 01:29:10 +08:00

54 lines
2.1 KiB
Markdown

# Comfortable Swipe (Ubuntu)
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
Comfortable 3-finger (and 4-finger) swipe gestures for Ubuntu 14.04 LTS+
## Installation
1. `sudo apt install libinput-tools libinput-dev libxdo-dev`
2. `git clone https://github.com/Hikari9/comfortable-swipe-ubuntu.git`
3. `cd comfortable-swipe-ubuntu`
4. `bash install`
## How to Run
1. Run `comfortable-swipe start` in Terminal
2. Flick away!
> If you get 'command not found' error or similar, try running with the full path: `/home/$USER/.local/bin/comfortable-swipe start`
### Permissions
Sometimes, you'll need some permissions to read touchpad input data. Perform these steps to solve the permission issue:
1. `sudo gpasswd -a $USER input`
2. Log out / log back in
### Optional: Add to Startup Applications
1. `gnome-session-properties`
2. Click `Add`
3. Enter the following:
Name | Comforable Swipe
------- | -------------------
Command | `comfortable-swipe-start`
Comment | Comfortable 3 or 4 finger swipe gestures
4. Save
## Configurations
The configuration file is located at `~/.config/comfortable-swipe.conf`.
Make sure to run `comfortable-swipe restart` after making changes.
Property | Description | Default Value | Default Behavior
--------- | ----------- | -------------- | -----
left3 | 3-finger swipe left | ctrl+shift+Right | switch to right workspace
right3 | 3-finger swipe right | ctrl+shift+Left | switch to left workspace
up3 | 3-finger swipe up | super+w | window spread
down3 | 3-finger swipe down | super+w | window spread
left4 | 4-finger swipe left | ctrl+alt+shift+Right | move window to right workspace
right4 | 4-finger swipe right | ctrl+alt+shift+Left | move window to left workspace
up4 | 4-finger swipe up | super+d | show desktop
down4 | 4-finger swipe down | super+d | show desktop
threshold | mouse pixels to activate swipe; higher = less sensitive; integers only | 20
## Bug Reports
Create an issue [here](https://github.com/Hikari9/comfortable-swipe-ubuntu/issues/new) to report a bug.