first commit

README.md

@@ -0,0 +1,112 @@
+<p align="center"><img src="data/input-remapper.svg" width=100/></p>
+
+<h1 align="center">Input Remapper</h1>
+
+<p align="center">
+  An easy to use tool for Linux to change the behaviour of your input devices.<br/>
+  Supports X11, Wayland, combinations, programmable macros, joysticks, wheels,<br/>
+  triggers, keys, mouse-movements and more. Maps any input to any other input.
+</p>
+
+<p align="center"><a href="readme/usage.md">Usage</a> - <a href="readme/macros.md">Macros</a> - <a href="#installation">Installation</a> - <a href="readme/development.md">Development</a> - <a href="readme/examples.md">Examples</a></p>
+
+<p align="center"><img src="readme/pylint.svg"/> <img src="readme/coverage.svg"/></p>
+
+
+<p align="center">
+  <img src="readme/screenshot.png" width="48%"/>
+  &#160;
+  <img src="readme/screenshot_2.png" width="48%"/>
+</p>
+
+<br/>
+
+## Installation
+
+### Ubuntu/Debian
+
+Either download an installable .deb file from the [latest release](https://github.com/sezanzeb/input-remapper/releases):
+
+```sh
+wget https://github.com/sezanzeb/input-remapper/releases/download/2.2.1/input-remapper-2.2.1.deb
+sudo apt install -f ./input-remapper-2.2.1.deb
+```
+
+Or install the very latest changes via:
+
+```sh
+sudo apt install git gettext
+git clone https://github.com/sezanzeb/input-remapper.git
+cd input-remapper
+./scripts/build-deb.sh
+sudo apt purge input-remapper input-remapper-daemon input-remapper-gtk python3-inputremapper
+sudo apt install -f ./dist/input-remapper-2.2.1.deb
+```
+
+Input Remapper is also available in the repositories of [Debian](https://tracker.debian.org/pkg/input-remapper)
+and [Ubuntu](https://packages.ubuntu.com/oracular/input-remapper) via
+
+```sh
+sudo apt install input-remapper
+```
+
+Input Remapper ≥ 2.0 requires at least Ubuntu 22.04.
+
+<br/>
+
+### Fedora
+
+```sh
+sudo dnf install input-remapper
+sudo systemctl enable --now input-remapper
+```
+
+<br/>
+
+### Arch
+
+```sh
+yay -S input-remapper-git
+sudo systemctl enable --now input-remapper
+```
+
+<br/>
+
+### Void
+
+```sh
+sudo xbps-install -S input-remapper
+sudo ln -s /etc/sv/input-remapper /var/service
+sudo sv up input-remapper
+```
+
+<br/>
+
+### Other Distros
+
+Figure out the packages providing those dependencies in your distro, and install them:
+`python3-evdev` ≥1.3.0, `gtksourceview4`, `python3-devel`, `python3-pydantic`,
+`python3-dasbus`, `python3-psutil`
+
+You can also use pip to install some of them. Python packages need to be installed
+globally for the service to be able to import them. Don't use `--user`. Conda and such
+may also cause problems due to changed python paths and versions.
+
+```sh
+sudo pip install evdev pydantic dasbus PyGObject
+```
+
+```sh
+git clone https://github.com/sezanzeb/input-remapper.git
+cd input-remapper
+sudo python3 -m install --root /
+sudo systemctl enable --now input-remapper
+```
+
+For all other options and help, check `python3 -m install --help`
+
+To uninstall:
+
+```sh
+sudo python3 -m install.uninstall
+```