You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-4Lines changed: 12 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,13 +13,21 @@ Alternately, you can download it from PyPi:
13
13
14
14
1. Install Python 3
15
15
2. Run `pip install REVHubInterface` to install
16
-
3. Finally, run `python3 -m REVHubInterface` to run the app
16
+
3. Finally, run `python3 -m REVHubInterface` to run the app (it should also be runnable as `revhubinterface`)
17
+
18
+
To avoid needing to run with root privlages on Ubuntu based platforms (and possibly other distributions) you need to add your user to the `dialout` group:
19
+
20
+
1. run `sudo usermod -a -G dialout <username>`, where `<username>` is the user you want to be able to run REV Hub Interface
21
+
2. reboot
17
22
18
23
Firmware updates require installing a driver.
19
24
20
-
- Windows: The newest versions of Windows should automatically install the required USB drivers. Alternatively, you can download the latest drivers from the [FTDI VCP website](https://www.ftdichip.com/Drivers/VCP.htm).
21
-
- Linux: The latest `libftdi` is provided in the Flatpak. If installing via PyPI instead, you will need to install `libftdi` yourself. On Ubuntu and derivitaves, this can be installed with `sudo apt install libftdi1`. The package name may be similar on other distributions.
22
-
- macOS: (TODO: figure out; ~~`brew install libftdi` doesn't seem to make the error go away.~~ UPDATE: https://github.com/lsgunth/pyft232/pull/22 is merged but not yet published, in the mean time we should manually apply the change in our releases that have the library bundled. Also, should we bundle `libftdi1.dylib` and its dependencies, or request users install it via Homebrew themselves?)
25
+
(Firmware has been ommited from the initial releases)
26
+
27
+
~~- Windows: The newest versions of Windows should automatically install the required USB drivers. Alternatively, you can download the latest drivers from the [FTDI VCP website](https://www.ftdichip.com/Drivers/VCP.htm).~~
28
+
~~- Linux: The latest `libftdi` is provided in the Flatpak. If installing via PyPI instead, you will need to install `libftdi` yourself. On Ubuntu and derivitaves, this can be installed with `sudo apt install libftdi1`. The package name may be similar on other distributions.~~
29
+
~~- macOS: (TODO: figure out; `brew install libftdi` doesn't seem to make the error go away. UPDATE: https://github.com/lsgunth/pyft232/pull/22 is merged but not yet published, in the mean time we should manually apply the change in our releases that have the library bundled. Also, should we bundle `libftdi1.dylib` and its dependencies, or request users install it via Homebrew themselves?~~
0 commit comments