From a8e779cc06c55473af95eef7c69cacca21fe2827 Mon Sep 17 00:00:00 2001 From: sezanzeb Date: Thu, 26 Nov 2020 23:52:58 +0100 Subject: [PATCH] Update README.md --- README.md | 36 +++++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 4fa22013..d9685270 100644 --- a/README.md +++ b/README.md @@ -10,21 +10,26 @@ ## Table of Contents -- [Dependencies](#Dependencies) -- [Installation](#Installation) +- [Packages](#Packages) +- [Usage](#Packages) +- [Git Installation](#Git_Installation) - [Tests](#Tests) - [Roadmap](#Roadmap) -## Installation +## Packages + +TODO + +## Usage + +To open the UI to modify the mappings, use: ```bash -git clone https://github.com/sezanzeb/key-mapper.git -cd key-mapper -sudo python3 setup.py install -usermod -a -G input $USER -usermod -a -G plugdev $USER +key-mapper-gtk ``` +You can also start it via your applications menu. + To keep injecting the mapping after closing the window, the daemon needs to be running. If it doesn't already after logging in, you can use: @@ -32,17 +37,18 @@ be running. If it doesn't already after logging in, you can use: key-mapper-service ``` -To open the UI to modify the mappings, use: +## Git Installation ```bash -key-mapper-gtk +git clone https://github.com/sezanzeb/key-mapper.git +cd key-mapper +sudo python3 setup.py install +usermod -a -G input $USER +usermod -a -G plugdev $USER ``` -You can also start it via your applications menu. - -## Dependencies - -Depending on how those packages are called in your distro: +Depending on how those packages are called in your distro, +you need the following dependencies: `python3-distutils-extra` `python3-evdev` `python3-dbus`