Skip to content

Commit 35baec0

Browse files
Update README with new install instructions and strike through for the firmware section
1 parent 13d1aad commit 35baec0

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,21 @@ Alternately, you can download it from PyPi:
1313

1414
1. Install Python 3
1515
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
1722

1823
Firmware updates require installing a driver.
1924

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?~~
30+
2331

2432
## Connecting and Controlling an Expansion Hub
2533

0 commit comments

Comments
 (0)