Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sebelino committed Dec 24, 2015
1 parent 323eabf commit 13fb188
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,24 @@ The configuration file follows a Vimscript-like syntax. Each line in the configu
* ``map KEY MOUSEBUTTON`` causes mouse button MOUSEBUTTON to be pressed/released whenever key KEY is pressed/released.
* ``refreshrate MILLISECONDS`` tells the program to handle key events every MILLISECONDS milliseconds. This affects the speed at which the mouse is moved.

## Example
## Example usage
``sample.conf`` contains a sample configuration. To use it, supply the ``--config`` flag:
```
$ python kecomp.py -c sample.conf
```
Alternatively, rename it to ``kecomp.conf``.

## Sample configuration
```
steer <Up> 0 -3
steer <Down> 0 1
steer <Left> -1 0
steer <Right> 1 0
default speed 15
speed B 30
speed C /3
speed V *0.2
map Z <LeftMouse>
map X <RightMouse>
refreshrate 10
```

0 comments on commit 13fb188

Please sign in to comment.