mirror of
https://github.com/sbrow/nu-ffmpeg.git
synced 2025-12-29 16:23:11 -05:00
docs: Improved README.md.
This commit is contained in:
44
README.md.tmpl
Normal file
44
README.md.tmpl
Normal file
@@ -0,0 +1,44 @@
|
||||
{{ if false }}
|
||||
<!--
|
||||
vim: filetype=markdown :
|
||||
->
|
||||
|
||||
{{ end }}
|
||||
# nu-ffmpeg
|
||||
|
||||
Utility commands for working with ffmpeg in nushell.
|
||||
|
||||
## Capabilities
|
||||
|
||||
- Return tables from `ffprobe`
|
||||
- `ffprobe` multiple files at once
|
||||
- Use `streams`, `streams video`, and `streams audio` to filter `ffprobe` output
|
||||
- get the `dimensions` of a video stream as a record
|
||||
- Apply and parse complex filters to a video (Work In Progress)
|
||||
|
||||
## Setup
|
||||
|
||||
The `ffmpeg` and `ffprobe` commands are required to be installed and available
|
||||
in your path; they are not installed for you.
|
||||
|
||||
Currently only nushell version 0.89.0 is supported.
|
||||
|
||||
After that, clone this repository and add the following code to your scripts,
|
||||
or to your `config.nu` file:
|
||||
|
||||
```nu
|
||||
use <path-to-repository>/ffprobe
|
||||
use <path-to-repository>/filters *
|
||||
```
|
||||
|
||||
## FFProbe
|
||||
|
||||
### Commands
|
||||
|
||||
{{ ffprobe }}
|
||||
|
||||
## FFMpeg
|
||||
|
||||
## Supported Filters
|
||||
|
||||
{{ filters }}
|
||||
Reference in New Issue
Block a user