mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-04-10 21:03:01 +00:00
Update README.md
update readme commands Signed-off-by: Chuck <33324927+ChuckBuilds@users.noreply.github.com>
This commit is contained in:
21
README.md
21
README.md
@@ -30,6 +30,16 @@ cp config/config.example.json config/config.json
|
|||||||
|
|
||||||
2. Edit `config/config.json` with your preferences
|
2. Edit `config/config.json` with your preferences
|
||||||
|
|
||||||
|
## API Keys
|
||||||
|
|
||||||
|
For sensitive settings like API keys:
|
||||||
|
1. Copy the template: `cp config/config_secrets.template.json config/config_secrets.json`
|
||||||
|
|
||||||
|
2. Edit `config/config_secrets.json` with your API keys via `sudo nano config/config_secrets.json`
|
||||||
|
|
||||||
|
3. Ctrl + X to exit, Y to overwrite, Enter to save
|
||||||
|
|
||||||
|
|
||||||
## Important: Sound Module Configuration
|
## Important: Sound Module Configuration
|
||||||
|
|
||||||
1. Remove unnecessary services that might interfere with the LED matrix:
|
1. Remove unnecessary services that might interfere with the LED matrix:
|
||||||
@@ -72,15 +82,6 @@ sudo reboot
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## API Keys
|
|
||||||
|
|
||||||
For sensitive settings like API keys:
|
|
||||||
1. Copy the template: `cp config/config_secrets.template.json config/config_secrets.json`
|
|
||||||
|
|
||||||
2. Edit `config/config_secrets.json` with your API keys via `sudo nano config/config_secrets.json`
|
|
||||||
|
|
||||||
3. Ctrl + X to exit, Y to save
|
|
||||||
|
|
||||||
## Running the Display
|
## Running the Display
|
||||||
|
|
||||||
From the project root directory:
|
From the project root directory:
|
||||||
@@ -116,4 +117,4 @@ LEDSportsMatrix/
|
|||||||
- `display_manager.py` - LED matrix display handling
|
- `display_manager.py` - LED matrix display handling
|
||||||
- `config/`
|
- `config/`
|
||||||
- `config.json` - Configuration settings
|
- `config.json` - Configuration settings
|
||||||
- `config_secrets.json` - Private settings (not in git)
|
- `config_secrets.json` - Private settings (not in git)
|
||||||
|
|||||||
Reference in New Issue
Block a user