Update README with sudo info and remove unused files

Added section on running without sudo (gpio group).

Removed integrate_news_ticker.py, src/mqtt_manager.py, and test_stock_news_manager.py as they were unused.
This commit is contained in:
ChuckBuilds
2025-04-17 10:07:45 -05:00
parent 866a1f9901
commit dcd1f42bc4
4 changed files with 27 additions and 318 deletions

View File

@@ -82,9 +82,34 @@ sudo nano /boot/firmware/cmdline.txt
sudo reboot
```
### Running without Sudo (Optional)
To run the display script without `sudo`, the user executing the script needs access to GPIO pins. Add the user to the `gpio` group:
This is required to download the Stock Symbol icons into assets/stocks.
```bash
sudo usermod -a -G gpio <your_username>
# Example for user 'ledpi':
# sudo usermod -a -G gpio ledpi
```
**Important:** You must **reboot** the Raspberry Pi after adding the user to the group for the change to take effect.
You also need to disable hardware pulsing in the code (see `src/display_manager.py`, set `options.disable_hardware_pulsing = True`). This has already been done in the repository if you are up-to-date.
If configured correctly, you can then run:
```bash
python3 display_controller.py
```
```
## Running the Display
(This is how I used to run the command, I may remove this in the future)
From the project root directory:
```bash
sudo python3 display_controller.py
@@ -108,8 +133,6 @@ LEDSportsMatrix/
│ └── weather.py # Weather display module
└── display_controller.py # Main entry point
```
## Project Structure
- `src/`
@@ -122,4 +145,5 @@ LEDSportsMatrix/
## Fonts
You can add any font to the assets/fonts/ folder but they need to be .ttf and updated in display_manager.py
You can add any font to the assets/fonts/ folder but they need to be .ttf and updated in display_manager.py