update readme and check
This commit is contained in:
@@ -7,10 +7,14 @@ While created for my own use, they are shared here in case others find them usef
|
||||
## Scripts
|
||||
|
||||
- **av1**: (DEPRECATED - use vcmp instead) Recursively compresses video files to AV1/MP4 format with reduced quality/size
|
||||
- **check**: Validates script dependencies and configuration
|
||||
- **e-ink**: Display handler for e-ink displays with image cycling support
|
||||
- **indeel**: File organization tool that watches a directory and sorts incoming files based on content hashes
|
||||
- **mover**: Monitors a source directory and moves files with specified extensions to a destination directory
|
||||
- **pushover**: Sends push notifications via Pushover API
|
||||
- **stats**: HTTP server that provides system statistics (CPU, memory, disk usage, etc.) in JSON format
|
||||
- **stats-collector**: Collects and stores system statistics from multiple hosts
|
||||
- **syncwall**: Downloads and sets wallpaper with pywal integration
|
||||
- **vc**: Video converter using ffmpeg and youtube-dl for local files or YouTube URLs
|
||||
- **vcmp**: Advanced video compression utility with progress tracking and logging
|
||||
|
||||
@@ -28,12 +32,15 @@ source /path/to/repo/scripts/install.sh
|
||||
|
||||
## Requirements
|
||||
|
||||
Use the `check` utility to verify script dependencies are installed:
|
||||
```bash
|
||||
check
|
||||
```
|
||||
|
||||
- ffmpeg
|
||||
- imagemagick
|
||||
- youtube-dl
|
||||
- youtube-dl/yt-dlp
|
||||
- pushover API tokens
|
||||
- Whatever the relevant script errors about
|
||||
|
||||
## Usage
|
||||
|
||||
Each script includes help documentation accessible via `-h` or `--help` flag. See individual script headers for detailed usage instructions.
|
||||
- Python 3.x
|
||||
- Additional Python packages (sqlalchemy, requests)
|
||||
- Optional: RPi.GPIO and spidev for e-ink display support
|
||||
|
||||
Reference in New Issue
Block a user