more work on distribution

MANIFEST.in

@@ -1,4 +1,4 @@
-# for `python3 setup.py sdist`
+# for /scripts/build.sh
 recursive-include data *
 include bin/key-mapper-gtk
 include bin/key-mapper-service

README.md

@@ -2,6 +2,12 @@
 
 <p align="center">A Linux tool to change and program the mapping of your input device buttons.</p>
 
+<p align="center">
+    <a href="#Ubunut/Debian">Ubunut/Debian</a>
+    <a href="#Manjaro/Arch">Manjaro/Arch</a>
+    <a href="#Git">Git</a>
+</p>
+
 <p align="center"><img src="readme/pylint.svg"/> <img src="readme/coverage.svg"/></p>
 
 <p align="center"><img src="readme/screenshot.png"/></p>
@@ -24,6 +30,8 @@ be running. If it doesn't already after logging in, you can use:
 key-mapper-service
 ```
 
+It works with both Wayland and X11.
+
 ## Macros
 
 It is possible to write timed macros into the center column:
@@ -41,7 +49,25 @@ Documentation:
 For a list of supported keystrokes and their names, check the output of
 `xmodmap -pke`
 
-## Git Installation
+## Installation
+
+#### Ubunut/Debian
+
+```bash
+dpkg -i $(wget TODO)
+usermod -a -G input $USER
+usermod -a -G plugdev $USER
+```
+
+#### Manjaro/Arch
+
+TODO
+
+```bash
+pacaur -S key-mapper-git
+```
+
+#### Git
 
 ```bash
 git clone https://github.com/sezanzeb/key-mapper.git
@@ -54,9 +80,7 @@ usermod -a -G plugdev $USER
 Depending on how those packages are called in your distro,
 you need the following dependencies:
 
-`python3-evdev` `python3-dbus`
-
-It works with both Wayland and X11.
+`python3-setuptools` `python3-evdev` `python3-dbus`
 
 ## Tests
 
@@ -80,5 +104,5 @@ sudo python3 setup.py install && python3 tests/test.py
 - [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 and .appimage files
+- [ ] add to the AUR, provide .deb file
 - [ ] automatically load presets when devices get plugged in after login

readme/coverage.svg

@@ -9,13 +9,13 @@
     </mask>
     <g mask="url(#a)">
         <path fill="#555" d="M0 0h63v20H0z"/>
-        <path fill="#dfb317" d="M63 0h36v20H63z"/>
+        <path fill="#a4a61d" d="M63 0h36v20H63z"/>
         <path fill="url(#b)" d="M0 0h99v20H0z"/>
     </g>
     <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11">
         <text x="31.5" y="15" fill="#010101" fill-opacity=".3">coverage</text>
         <text x="31.5" y="14">coverage</text>
-        <text x="80" y="15" fill="#010101" fill-opacity=".3">61%</text>
-        <text x="80" y="14">61%</text>
+        <text x="80" y="15" fill="#010101" fill-opacity=".3">87%</text>
+        <text x="80" y="14">87%</text>
     </g>
 </svg>

scripts/build.sh

@@ -1,5 +1,4 @@
 #!/usr/bin/env bash
-# builds .deb and .appimage files in order to distribute them
 
 build_deb() {
   # https://github.com/phusion/debian-packaging-for-the-modern-developer/tree/master/tutorial-1
@@ -15,12 +14,7 @@ build_deb() {
   echo "created $dist/$name.deb"
 }
 
-build_appimage() {
-  echo "created $dist/$name.appimage"
-}
-
-
 build_deb &
-build_appimage &
+# add more build targets here
 
 wait