Skip to content

Commit 276db99

Browse files
committed
Update installation and post-installation instructions
* Update README * Add POST-INSTALL.md * Add udev-rule
1 parent ce7a7df commit 276db99

File tree

3 files changed

+43
-2
lines changed

3 files changed

+43
-2
lines changed

POST-INSTALL.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Post-installation instructions
2+
3+
These instructions will vary depending on your operating system. I can only hope it works on Mac, but I have no way of testing it at this moment
4+
5+
## Linux (Ubuntu, maybe others)
6+
By default [udev](https://en.wikipedia.org/wiki/Udev) denies access to devices by non-root users
7+
To give yourself access you must explicitly add the device through a udev rule
8+
9+
Copy the included [udev rules file](./udev-rule/99-luxafor-ui.rules) into the rules folder and reload udev
10+
11+
```bash
12+
# Copy udev rule into rules directory
13+
sudo cp ./udev-rule/99-luxafor-ui.rules /etc/udev/rules.d
14+
# Reload udev
15+
sudo udevadm control -R
16+
```
17+
18+
After this, unplug and plug back in the Flag. You should now be able to control the busylight
19+
20+
21+
## Windows
22+
Nothing. It should just work.
23+
24+
25+
## Mac
26+
/shrug
27+

README.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# Luxafor-ui
22
>Goal: create a simple, cross-platform graphical user interface to control the [Luxafor Flag](https://luxafor.com/products/) and perhaps other Luxafor busylights
33
4-
54
# Getting started
65

6+
## Installation
77
Pre-built binaries for the most common operating systems are available from [releases](https://github.com/nibrobb/luxafor-ui/releases), expand 'Assets' then choose the distribution that is right for your system.
8+
If you are on Mac, good luck.
9+
10+
### Post-install
811

12+
See [POST-INSTALL.md](./POST-INSTALL.md)
913

1014
## Build it yourself
1115
Get your Tauri [prerequisites](https://tauri.app/start/prerequisites/) in order first
@@ -15,12 +19,15 @@ Get your Tauri [prerequisites](https://tauri.app/start/prerequisites/) in order
1519
sudo apt install libgtk-3-dev libgdk3.0-cil-dev libatk1.0-dev libxdo-dev\
1620
librust-gio-sys-dev librust-pango-sys-dev librust-soup3-sys-dev\
1721
librust-gdk-pixbuf-sys-dev libjavascriptcoregtk-4.1-dev\
18-
libwebkit2gtk-4.1-dev libayatana-appindicator3-dev # or libappindicator3-dev
22+
libwebkit2gtk-4.1-dev \
23+
libayatana-appindicator3-dev # or libappindicator3-dev
1924
```
2025

2126
## NixOS
2227
Use included `shell.nix`
2328

29+
Good luck.
30+
2431

2532
## Common steps
2633
Install the Tauri command line interface `tauri-cli`, the wasm-bundler `trunk` and the wasm32 target
@@ -61,6 +68,9 @@ cargo tauri build
6168
#### Setting up `trunk` to not use native Open SSL (which is a pain in the ass to set up)
6269
- https://users.rust-lang.org/t/install-cargo-trunk-issue-with-x86-64-pc-windows-gnu-target/121119
6370

71+
#### Inspiration and udev rules borrowed from
72+
- https://github.com/JnyJny/busylight
73+
6474
#### Luxafor library in rust
6575
- https://crates.io/crates/luxafor
6676

udev-rule/99-luxafor-ui.rules

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Luxafor Flag
2+
KERNEL=="hidraw*", ATTRS{idVendor}=="04d8", ATTRS{idProduct}=="f372", MODE="0660"
3+
SUBSYSTEM=="usb", ATTRS{idVendor}=="04d8", ATTRS{idProduct}=="f372", MODE="0660"
4+

0 commit comments

Comments
 (0)