Skip to content

Commit

Permalink
* Added apt-get packages
Browse files Browse the repository at this point in the history
* Added Documentation
  • Loading branch information
Zwixx committed Dec 22, 2023
1 parent 73e0cfb commit 4a7a5f9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/c-cpp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ jobs:
steps:
- uses: actions/checkout@v3
- name: install libusb-dev
run: sudo apt-get -q install libusb-1.0-0-dev xdotool -y
run: sudo apt-get -q install libusb-1.0-0-dev libx11-dev libwayland-dev -y
- name: make
run: make
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ Pre-Installation
------------
Arch Linux/Manjaro:
```
sudo pacman -S libusb-1.0 xdotool
sudo pacman -S libusb-1.0 xdotool libx11
```
Ubuntu/Debian/Pop OS:
```
sudo apt-get install libusb-1.0-0-dev xdotool
sudo apt-get install libusb-1.0-0-dev xdotool libx11-dev libwayland-dev
```
> **_NOTE:_** Some distros label libusb as "libusb-1.0-0" and others might require the separate "libusb-1.0-dev" package
Expand Down Expand Up @@ -41,16 +41,26 @@ sudo ./KD100 [options]

**-h** Displays a help message

Create .deb package
-------------------

Creates a Debian Package, that's installs the binary and set udev-Rules for all Users.

```
make deb
```

Configuring
----------
Edit or copy **default.cfg** to add your own keys/commands and use the **-c** flag to specify the location of the config file. New config files do not need to end in ".cfg". If the config file is not found in the current directory, the driver while look for it in ~/.config/KD100/

Caveats
-------
- Because the driver relies on xdotool, it only works on X11 desktops but it can be patched for wayland desktops by altering the "handler" function
- You do not need to run this with sudo if you set a udev rule for the device. Create/edit a rule file in /etc/udev/rules.d/ and add the following:
- You do not need to run this with sudo if you set a udev rule for the device. Create/edit a .rules (for example 99-huion.rules) file in /etc/udev/rules.d/ and add the following:
```
SUBSYSTEM=="usb",ATTRS{idVendor}=="256c",ATTRS{idProduct}=="006d",MODE="0666"
SUBSYSTEM=="usb",ATTRS{idVendor}=="256c",ATTRS{idProduct}=="0069",MODE="0666"
```
Save and then reboot or reload your udev rules with:
```
Expand All @@ -67,6 +77,7 @@ Tested Distros
- Manjaro
- Ubuntu
- Pop OS
- Kali Linux

Known Issues
------------
Expand Down

0 comments on commit 4a7a5f9

Please sign in to comment.