Add agent skill documentation section to README.md explaining SKILL.md file purpose, prerequisites coverage, safety rules, script catalog structure, and installation instructions for Devin and Claude Code agents, with repository location notes for both SVN and Git versions
This commit is contained in:
1 parent
95e8d94298
commit
693655d07d
1 file changed
+21
@@ -88,6 +88,27 @@ Add the project folder to your PATH environment variable to access the scripts f
|
||||
|
||||
---
|
||||
|
||||
## Agent Skill
|
||||
|
||||
[SKILL.md](SKILL.md) is an agent skill for AI coding agents (such as Claude Code or Devin). It teaches the agent how to use these scripts safely, so the agent does not have to rediscover the documentation for each task.
|
||||
|
||||
What it covers:
|
||||
|
||||
- **Prerequisites and environment**: PowerShell 7+, ffmpeg, ffprobe, rife-ncnn-vulkan and upscayl-bin, and the `RIFE_HOME`, `UPSCAYL_HOME` and `NCNN_GPU_ID` variables. The agent checks them once before first use, and stops to ask you if something is missing instead of installing it.
|
||||
- **Safety rules**: it always previews with `-WhatIf` first, never passes `-Confirm`, and lists which scripts overwrite or delete existing files.
|
||||
- **Script catalog**: every script with a one-line purpose and a link to its page. The agent loads a page only when it needs the details.
|
||||
- **Workflows and troubleshooting**: common recipes, such as clipping a frame range or detecting scenes, and the documented error messages with their fixes.
|
||||
|
||||
To use it, copy the file into your agent's skills folder in a folder named `video-processing-scripts`. For example:
|
||||
|
||||
- Devin: `.devin/skills/video-processing-scripts/SKILL.md`
|
||||
- Claude Code: `.claude/skills/video-processing-scripts/SKILL.md`
|
||||
|
||||
The skill is available in both repositories:
|
||||
|
||||
- **SVN** (project `Video Processing Scripts`): `mkdocs/SKILL.md`
|
||||
- **Git** (`guru/Video-Processing-Scripts`): `SKILL.md` at the repository root. `Update-Git-Publish.ps1` copies it from `mkdocs/SKILL.md`.
|
||||
|
||||
## Notes
|
||||
|
||||
- All scripts require PowerShell 7+ (use `pwsh.exe`)
|
||||
|
||||
Reference in new issue
Block a user