Update README

Add better instructions for autostart and permissions
This commit is contained in:
Rico Tiongson 2017-10-23 23:37:40 +08:00
parent 1c7c0bb10f
commit a3696eb92b
2 changed files with 52 additions and 25 deletions

View File

@ -1,38 +1,65 @@
# Comfortable Swipe (Ubuntu) # Comfortable Swipe (Ubuntu)
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![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, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures for Ubuntu 14.04 LTS and beyond. May work for other Linux distros that support `libinput`.
## Installation ## Installation
1. `sudo apt-get install git libinput-tools libxdo-dev`
2. `git clone https://github.com/Hikari9/comfortable-swipe-ubuntu.git` 1. Install `libinput-tools` and `libxdo-dev`
3. `cd comfortable-swipe-ubuntu`
4. `bash install` ```bash
5. You may delete the downloaded `comfortable-swipe-ubuntu` folder. sudo apt-get install libinput-tools libxdo-dev
```
2. Clone this repository
```bash
git clone https://github.com/Hikari9/comfortable-swipe-ubuntu.git
cd comfortable-swipe-ubuntu
```
3. Install
```bash
bash install
```
4. You may delete the downloaded `comfortable-swipe-ubuntu` folder after installation.
## How to Run ## How to Run
1. Run `comfortable-swipe start` in Terminal
2. Flick away!
> If you're getting *command not found*, try running: `/home/$USER/.local/bin/comfortable-swipe start` 1. Make sure `~/.local/bin/` is added to your PATH.
2. Run
```
comfortable-swipe start
```
3. Optional: Automatically run on startup
```
comfortable-swipe-autostart
```
### Permissions ### 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` 1. Find out your permission group with `ls -l /dev/input/event*`
2. Log out / log back in ```bash
$ ls -l /dev/input/event*
### Optional: Add to Startup Applications crw-rw---- 1 root input 13, 64 Oct 23 23:09 /dev/input/event0
1. `gnome-session-properties` crw-rw---- 1 root input 13, 65 Oct 23 23:09 /dev/input/event1
2. Click `Add` crw-rw---- 1 root input 13, 66 Oct 23 23:09 /dev/input/event2
3. Enter the following: crw-rw---- 1 root input 13, 67 Oct 23 23:09 /dev/input/event3
```
Name | Comforable Swipe 2. Check the fourth column (e.g. `input`) then run
------- | ------------------- ```bash
Command | `comfortable-swipe-start` sudo gpasswd -a $USER input
Comment | Comfortable 3 or 4 finger swipe gestures ```
4. Save 3. ***Important***: Log out / Log back in
## Configurations ## Configurations
The configuration file is located at `~/.config/comfortable-swipe.conf`. The configuration file is located at `~/.config/comfortable-swipe.conf`.
@ -51,7 +78,7 @@ down4 | 4-finger swipe down | super+d | show desktop
threshold | mouse pixels to activate swipe; higher = less sensitive; integers only | 20 threshold | mouse pixels to activate swipe; higher = less sensitive; integers only | 20
## Uninstall ## Uninstall
1. `bash uninstall` Download the `uninstall` script then run `bash uninstall`
## Bug Reports ## Bug Reports
Create an issue [here](https://github.com/Hikari9/comfortable-swipe-ubuntu/issues/new) to report a bug. Create an issue [here](https://github.com/Hikari9/comfortable-swipe-ubuntu/issues/new) to report a bug.

View File

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