From e8d34f420cf2a7a81115f0c2983378f72bf62484 Mon Sep 17 00:00:00 2001 From: Jonathan Cobb Date: Thu, 17 Dec 2020 17:45:52 -0500 Subject: [PATCH] update docs --- docs/running.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/running.md b/docs/running.md index 404ec03..3bfe4dd 100644 --- a/docs/running.md +++ b/docs/running.md @@ -4,16 +4,24 @@ The `jvc` script (in the `bin` directory) is the primary way to transform video assets with JVC. +It is the swiss army knife that reads a spec file and can perform any number of +operations on any number of assets. + ## Operation-specific scripts There are other scripts in [`bin`](../bin) that perform a single operation using -command-line arguments. If you need to do a quick operation and don't want to write -a JVC spec, use one of [these tools](../bin). +command-line arguments, without requiring you to write a spec file. + +If you need to do a quick operation and don't feel like writing up a quick JSON +spec file, use one of [these tools](../bin). For example, to extract the first 5 seconds of a video: ```shell script jtrim /tmp/input-file.mp4 /tmp/output-5s.mp4 0 5 ``` +There is a command-line tool for every operation except for `overlay` and +`ken-burns`, which are more complex. Pull requests welcome. + ## Help All commands accept a `-h` / `--help` option, this will print information about how to use the command, and what arguments it takes.