From 5172c0c20e540c22f41d97306464e8b7cdd7b46a Mon Sep 17 00:00:00 2001 From: Dmytro Tkanov Date: Mon, 18 Mar 2019 12:54:15 +0200 Subject: [PATCH] setup fixes --- README.md | 26 +++++++++++++++++--------- setup.py | 4 +++- 2 files changed, 20 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e1e564b..c114f4e 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,40 @@ # MiceLess Utitlity that helps binding keyboard shortcuts for some of the operations that you do with mouse. -# Usecase +## Usecase Primary usecase that this tool was written for is switching focus between windows on different monitors. In some cases, e.g. multiple desktops, simple `Alt-TAB` wont help, because it would either switch you to latest used app or would require you to press this combo several times, until you reach target window. With this tool you can configure shortcuts so that, for example, `Ctrl-Alt-1` would set window in left monitor in focus and `Ctrl+Alt+2` would set focus for window in right monitor. -# Manual -MiceLess stores a mapping between key-combos and sequences of mouse clicks. -To run the app, execute `run.py` with `python3` interpreter. +## Installation +Via PIP: +```bash +pip install miceless +``` +To run the app, execute: +```python3 +python3 -m miceless.run +``` -App config would be stored in home folder in `.miceless` file. +## Manual +MiceLess stores a mapping between key-combos and sequences of mouse clicks. +App config would be stored in home folder in `.miceless` file. The app should work anywhere where `pynput` works, yet it has been tested only on Ubuntu with X server. -## Modes +### Modes The tool has two operation modes: **recording** and **playback**. You can switch between modes by pressing `Ctrl+Alt+~`. -## Recording +### Recording While in **recording** mode, `Ctrl-Alt-` combo would **append** click in current mouse location to the list of events for a given combo. Pressing special combination `Ctrl+Alt+0` would clear events list for last used key combo. -## Playback +### Playback In playback mode pressing `Ctrl+Alt+` combo would invoke a sequence of events stored for that combination. -# Known issues +## Known issues * Playback clicks are executed with `Ctrl+Alt` pressed, because all combos have these keys in them. This might be a problem for some applications. * There might be collisions with app-specific hotkeys that would result in not desired firings of event sequences. diff --git a/setup.py b/setup.py index 0aae589..2f0d8f4 100644 --- a/setup.py +++ b/setup.py @@ -25,6 +25,8 @@ "Programming Language :: Python :: 3", "License :: OSI Approved :: Apache Software License", "Operating System :: POSIX :: Linux", - "Topic :: Multimedia :: Sound/Audio", + "Environment :: X11 Applications", + "Intended Audience :: End Users/Desktop", + "Topic :: Utilities", ], )