mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-04-12 13:42:59 +00:00
updated readme to include new displays
This commit is contained in:
27
README.md
27
README.md
@@ -104,8 +104,6 @@ If configured correctly, you can then run:
|
|||||||
python3 display_controller.py
|
python3 display_controller.py
|
||||||
```
|
```
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
## Running the Display
|
## Running the Display
|
||||||
|
|
||||||
(This is how I used to run the command, I may remove this in the future)
|
(This is how I used to run the command, I may remove this in the future)
|
||||||
@@ -123,22 +121,29 @@ The display will alternate between showing:
|
|||||||
|
|
||||||
The project structure is organized as follows:
|
The project structure is organized as follows:
|
||||||
```
|
```
|
||||||
LEDSportsMatrix/
|
LEDMatrix/
|
||||||
├── config/ # Configuration files
|
├── config/ # Configuration files
|
||||||
│ ├── config.json # Main configuration
|
│ ├── config.json # Main configuration
|
||||||
│ └── config_secrets.json# API keys and sensitive data
|
│ └── config_secrets.json # API keys and sensitive data
|
||||||
├── src/ # Source code
|
├── src/ # Source code
|
||||||
│ ├── display_manager.py # LED matrix display handling
|
│ ├── config_manager.py # Configuration loading
|
||||||
│ ├── clock.py # Clock display module
|
│ ├── display_manager.py # LED matrix display handling
|
||||||
│ └── weather.py # Weather display module
|
│ ├── clock.py # Clock display module
|
||||||
└── display_controller.py # Main entry point
|
│ ├── weather_manager.py # Weather display module
|
||||||
|
│ ├── stock_manager.py # Stock ticker display module
|
||||||
|
│ └── stock_news_manager.py # Stock news display module
|
||||||
|
└── display_controller.py # Main application controller
|
||||||
```
|
```
|
||||||
## Project Structure
|
## Project Structure
|
||||||
|
|
||||||
- `src/`
|
- `src/`
|
||||||
- `clock.py` - Main clock application
|
- `display_controller.py` - Main application controller
|
||||||
- `config_manager.py` - Configuration management
|
- `config_manager.py` - Configuration management
|
||||||
- `display_manager.py` - LED matrix display handling
|
- `display_manager.py` - LED matrix display handling
|
||||||
|
- `clock.py` - Clock display module
|
||||||
|
- `weather_manager.py` - Weather display module
|
||||||
|
- `stock_manager.py` - Stock ticker display module
|
||||||
|
- `stock_news_manager.py` - Stock news display module
|
||||||
- `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