ervin/comfortable-swipe
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

Browse Source 
Add better instructions for autostart and permissions
This commit is contained in:
Rico Tiongson 2017-10-23 23:37:40 +08:00
parent 7774ba1ccc
commit 2b3210b188
2 changed files with 45 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
README.md
View File

@ -1,38 +1,58 @@
# 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+
Comfortable 3-finger (and 4-finger) touchpad swipe gestures for Ubuntu 14.04 LTS onwards (and possibly other Linux distros).
## Installation
1. `sudo apt-get install git libinput-tools libxdo-dev`
2. `git clone https://github.com/Hikari9/comfortable-swipe-ubuntu.git`
3. `cd comfortable-swipe-ubuntu`
4. `bash install`
5. You may delete the downloaded `comfortable-swipe-ubuntu` folder.
1. Install `libinput-tools` and `libxdo-dev`
```bash
sudo apt-get install libinput-tools libxdo-dev
```
2. Clone this repository
```bash
git clone https://github.com/Hikari9/comfortable-swipe-ubuntu.git
```
3. Install
```bash
cd comfortable-swipe-ubuntu
bash install
```
4. You may delete the downloaded `comfortable-swipe-ubuntu` folder.
## How to Run
1. Run `comfortable-swipe start` in Terminal
1. `comfortable-swipe start` or `~/.local/bin/comfortable-swipe start`
2. Flick away!
> If you're getting *command not found*, try running: `/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:
Sometimes, you'll need some permissions to read touchpad input data.
1. `sudo gpasswd -a $USER input`
2. Log out / log back in
1. Find out your permission group with `ls -l /dev/input/event*`
```bash
$ ls -l /dev/input/event*
crw-rw---- 1 root input 13, 64 Oct 23 23:09 /dev/input/event0
crw-rw---- 1 root input 13, 65 Oct 23 23:09 /dev/input/event1
crw-rw---- 1 root input 13, 66 Oct 23 23:09 /dev/input/event2
crw-rw---- 1 root input 13, 67 Oct 23 23:09 /dev/input/event3
```
2. Check the fourth column (e.g. `input`) then run
```bash
sudo gpasswd -a $USER input
```
3. ***Important***: 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
Just run `comfortable-swipe autostart`
## Configurations
The configuration file is located at `~/.config/comfortable-swipe.conf`.
@ -51,7 +71,7 @@ down4 | 4-finger swipe down | super+d | show desktop
threshold | mouse pixels to activate swipe; higher = less sensitive; integers only | 20
## Uninstall
1. `bash uninstall`
Download the `uninstall` script then run `bash uninstall`
## Bug Reports
Create an issue [here](https://github.com/Hikari9/comfortable-swipe-ubuntu/issues/new) to report a bug.

4
uninstall
View File

@ -1,6 +1,6 @@
#!/bin/bash
echo "Uninstalling..."
rm ${XDG_CONFIG_HOME:-$HOME/.config}/autostart/comfortable-swipe.desktop 2> /dev/null
comfortable-swipe stop 2> /dev/null
rm $HOME/.local/bin/comfortable-swipe 2> /dev/null
sleep 1
echo "Successfully uninstalled comfortable-swipe"
echo "Successfully uninstalled comfortablex-swipe"