From 12f6d32f527f15cc85f730ea8181892aaff290e9 Mon Sep 17 00:00:00 2001 From: Iris <87090296+Iris-TheRainbow@users.noreply.github.com> Date: Mon, 29 Jul 2024 19:34:49 -0500 Subject: [PATCH] Update README.md with some better wording and new instrutions --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 714a205..6e78e21 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ To avoid needing to run with root privileges on Ubuntu based platforms (and poss Firmware updates may require installing a driver. > [!WARNING] -> Firmware update functionality has been ommited from the initial release. +> Firmware update functionality has been ommited for releases.
Driver installation @@ -60,8 +60,10 @@ If you want to compile yourself rather than using a pre-packaged version, you wi - Python 3 - Tkinter - Windows: This is included in the Python 3 installer, just make sure sure it is selected to be installed at install time. - - Linux: On Ubuntu and derivatives, this is instaled with `sudo apt install python3-tk`. The package name will likely be similar on other distributions. + - Linux: On Ubuntu and derivatives, this is instaled with `sudo apt install python3-tk`. On arch, it can be installed with `sudo pacman -Su tk` The package name will likely be similar on other distributions. - macOS: If using Homebrew, it can be install via `brew install python-tk`. +> [!WARNING] +> Firmware update functionality has been ommited for releases and thus `libftdi` is not required. - On Linux, you will need to install `libftdi`. On Ubuntu and derivitaves, this can be installed with `sudo apt install libftdi1`. The package name may be similar on other distributions. - The remaining Python dependencies (currently `pyft232` and `pyserial`, subject to future changes) can be installed via `pip3 install -r requirements.txt` - Finally, run `python3 REVHubInterface` while in the base folder of the repo. @@ -84,7 +86,7 @@ You may want to setup an API key for easier login, see https://packaging.python. ### Pyinstaller Pyinstaller builds should be automated by pushing to the trigger-actions branch and binaries should be available in the actions tab. However, if you'd prefer to build from source: -1. Install PyInstaller (`pip install pyinstaller`) +1. Install PyInstaller (`pip install pyinstaller` or it may be present in a distro repository) 2. Run `pyinstaller REVHubInterface.spec` 3. The binary should be available in the `dist` folder