mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-04-10 13:02:59 +00:00
Remove breaking changes and migration details (#176)
Removed breaking changes section and related migration instructions from the README. Signed-off-by: Chuck <33324927+ChuckBuilds@users.noreply.github.com>
This commit is contained in:
25
README.md
25
README.md
@@ -27,20 +27,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
-----------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
## ⚠️ Breaking Changes
|
|
||||||
|
|
||||||
**Important for users upgrading from older versions:**
|
|
||||||
|
|
||||||
Script paths have been reorganized. If you have automation, cron jobs, or custom tooling that references old script paths, you **must** update them. See the [Migration Guide](MIGRATION_GUIDE.md) for details.
|
|
||||||
|
|
||||||
**Quick Reference:**
|
|
||||||
- Installation scripts moved: `install_service.sh` → `scripts/install/install_service.sh`
|
|
||||||
- Permission scripts moved: `fix_cache_permissions.sh` → `scripts/fix_perms/fix_cache_permissions.sh`
|
|
||||||
|
|
||||||
**Full migration instructions:** See [MIGRATION_GUIDE.md](MIGRATION_GUIDE.md)
|
|
||||||
|
|
||||||
-----------------------------------------------------------------------------------
|
-----------------------------------------------------------------------------------
|
||||||
|
|
||||||
## Core Features
|
## Core Features
|
||||||
@@ -339,7 +325,7 @@ This single script installs services, dependencies, configures permissions and s
|
|||||||
|
|
||||||
### Initial Setup
|
### Initial Setup
|
||||||
|
|
||||||
The system uses a template-based configuration approach to avoid Git conflicts during updates:
|
Edit the project via the web interface at http://ledpi:5000 or for manual control:
|
||||||
|
|
||||||
1. **First-time setup**: The previous "First_time_install.sh" script should've already copied the template to create your config.json:
|
1. **First-time setup**: The previous "First_time_install.sh" script should've already copied the template to create your config.json:
|
||||||
|
|
||||||
@@ -347,7 +333,7 @@ The system uses a template-based configuration approach to avoid Git conflicts d
|
|||||||
```bash
|
```bash
|
||||||
sudo nano config/config.json
|
sudo nano config/config.json
|
||||||
```
|
```
|
||||||
or edit via web interface at http://ledpi:5000
|
or
|
||||||
|
|
||||||
3. **Having Issues?**: Run the First Time Script again:
|
3. **Having Issues?**: Run the First Time Script again:
|
||||||
```bash
|
```bash
|
||||||
@@ -355,13 +341,6 @@ or edit via web interface at http://ledpi:5000
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### API Keys and Secrets
|
|
||||||
|
|
||||||
For sensitive settings like API keys:
|
|
||||||
1. Copy the secrets 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 Confirm
|
|
||||||
|
|
||||||
### Automatic Configuration Migration
|
### Automatic Configuration Migration
|
||||||
|
|
||||||
The system automatically handles configuration updates:
|
The system automatically handles configuration updates:
|
||||||
|
|||||||
Reference in New Issue
Block a user