Update README.md

xkb
sezanzeb 4 years ago committed by sezanzeb
parent 3173e9cd9e
commit 0f4ebaa2f0

@ -3,7 +3,7 @@
<p align="center">A tool to change and program the mapping of your input device buttons.</p>
<p align="center">
<a href="#ubuntudebian">Ubuntu/Debian</a><a href="#manjaroarch">Manjaro/Arch</a><a href="#git">Git</a>
<a href="#installation">Ubuntu/Debian</a><a href="#installation">Manjaro/Arch</a><a href="#installation">Git</a>
</p>
<p align="center"><img src="readme/pylint.svg"/> <img src="readme/coverage.svg"/></p>
@ -39,17 +39,24 @@ For a list of supported keystrokes and their names, check the output of
## Installation
##### Ubuntu/Debian
After your installation, independent of the method, you should add yourself
to the `input` and `plugdev` groups so that you can read keycodes from them.
You have to start the application via sudo otherwise.
```bash
wget "https://github.com/sezanzeb/key-mapper/releases/download/0.1.0/python3-key-mapper_0.1.0-1_all.deb"
sudo dpkg -i python3-key-mapper_0.1.0-1_all.deb
sudo usermod -a -G plugdev,input $USER
# log out and back in or restart,
# the two groups should be visible with:
# log out and back in or restart, the two groups should be visible with:
groups
```
##### Ubuntu/Debian
```bash
wget "https://github.com/sezanzeb/key-mapper/releases/"\
"download/0.1.0/python3-key-mapper_0.1.0-1_all.deb"
sudo dpkg -i python3-key-mapper_0.1.0-1_all.deb
```
##### Manjaro/Arch
```bash
@ -61,10 +68,6 @@ pacaur -S key-mapper-git
```bash
git clone https://github.com/sezanzeb/key-mapper.git
sudo pip install key-mapper
sudo usermod -a -G plugdev,input $USER
# log out and back in or restart,
# the two groups should be visible with:
groups
```
## Roadmap
@ -82,7 +85,7 @@ groups
- [x] automatically load presets on login for plugged in devices
- [x] make sure it works on wayland
- [x] support timed macros, maybe using some sort of syntax
- [ ] add to the AUR, provide .deb file
- [x] add to the AUR, provide .deb file
- [ ] automatically load presets when devices get plugged in after login
## Tests

Loading…
Cancel
Save