Skip to content

Commit

Permalink
readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
j5155 committed May 7, 2024
1 parent 7785de3 commit 8237cbd
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Alternately, you can download it from PyPi:
2. Run `pip install REVHubInterface` to install
3. Finally, run `python3 -m REVHubInterface` to run the app (it should also be runnable as `revhubinterface`)

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:
To avoid needing to run with root privileges on Ubuntu based platforms (and possibly other distributions) you need to add your user to the `dialout` group:

1. Run ```sudo usermod `whoami` -a -G dialout```
2. Reboot
Expand All @@ -41,7 +41,10 @@ Firmware updates may require installing a driver.
3. Press Connect. The software will scan and connect to the Expansion Hub. The various peripheral tabs will populate with controls once connected.

## Running the development version
If you want to run the development version from this repository rather than using a pre-packaged version, you will need to install a few additional dependencies:

Early binaries are availiable from the Actions tab, or from the pre-releases section of https://pypi.org/project/REVHubInterface/#history.

If you want to compile yourself rather than using a pre-packaged version, you will need to install a few additional dependencies:

- Python 3
- Tkinter
Expand All @@ -54,6 +57,8 @@ If you want to run the development version from this repository rather than usin
- Alternately, you can install onto your system from source using `pip install .` from the base folder of the repo, then using `python3 -m REVHubInterface` from anywhere.

## Compiling and publishing binaries
<details>
<summary>Directions for developers</summary>

### PyPi
PyPi builds *should* be automated by simply updating the trigger-actions branch, however, if you want to do it manually:
Expand All @@ -76,3 +81,5 @@ Pyinstaller builds should be automated by pushing to the trigger-actions branch
Install Flatpak and flatpak-builder
TODO: finish this with Flathub directions

</details>

0 comments on commit 8237cbd

Please sign in to comment.