summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 19 insertions, 9 deletions
diff --git a/README.md b/README.md
index 00d0389..1ad5b8c 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,14 @@
This program is a replacement for the physical mouse in X11.
-It aims to be simple and efficient.
-
Features:
- move the mouse with different speeds
- click and grab
+- scroll
- execute shell commands
-## Installation
+## Installation
```
make
sudo make install
@@ -22,14 +21,25 @@ Debian based distros:
sudo apt-get install libx11-dev libxtst-dev
```
-## Configuration
-
-Edit config.h and reinstall. The configuration file should be self explaining.
-
## Usage
When starting xmouseless, it grabs the keyboard and all defined bindings are
available. When pressing an exit key, the program exits.
-You probably want to define a key binding for xmouseless in your desktop
-environment or window manager.
+The usage is quite intuitive and with some practice, you can move the pointer to
+a specific location very fast. Basically, you move the pointer by pressing some
+keys (the defaults are i, k, j and l for up, down, left and right)
+and change the speed by pressing modifier keys.
+The keys f, d and s (by default) are used to simulate mouse clicks and grabbing.
+With some other keys, you can scroll up, down, left and right and execute
+previously defined shell commands.
+
+You probably want to define a key binding to start xmouseless.
+
+
+## Configuration
+
+The configuration is done in config.h, which is a C header file,
+but you don't need any programming knowledge to edit it.
+After you edited the file, you have to run make again.
+