docs(README): Update README to include utility scripts and tier creator usage instructions

This commit is contained in:
Sam Chau 2025-01-16 10:22:49 +10:30
parent 5efb30afd8
commit 1694ce4b69
1 changed files with 33 additions and 2 deletions

View File

@ -21,6 +21,37 @@ Contains thoroughly tested and verified database entries ready for production us
Contains the latest updates and additions that are pending formal verification. May include experimental patterns and profiles that require further testing.
### Feature Branches
## Scripts
Used for developing and testing new database entries, patterns, or major changes before merging into dev. These branches follow the naming convention: `feature/description-of-change`
The repository includes utility scripts to help maintain and generate database entries.
### Tier Creator
A Python script that generates Custom Formats and Regex Patterns from tier data files.
**Location**: `/scripts/tierCreator.py`
**Usage**:
```bash
python tierCreator.py <json_file> --resolution <resolution> --type <type> [--dry-run]
```
**Arguments**:
- `json_file`: Path to a JSON file in `/tiers` containing release group tier data
- `--resolution`: One of: SD, 720p, 1080p, 2160p
- `--type`: One of: Quality, Balanced
- `--dry-run`: Optional flag to preview changes without writing files
**Example**:
```bash
python tierCreator.py ../tiers/2160p_quality.json --resolution 2160p --type Quality
```
The script will:
1. Read the tier data from the specified JSON file
2. Create regex patterns in `/regex_patterns` for any release groups that don't have one
3. Generate custom formats in `/custom_formats` for each tier