Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
HenrySlawniak committed Sep 12, 2018
1 parent 36bf94f commit 1d2f462
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions Readme.md
@@ -0,0 +1,19 @@
# Thumbnailer

_An open-source contact sheet tool_

## Install

1. Download the latest release from the [Releases](https://github.com/HenrySlawniak/thumbnailer/releases) page
2. Download ffmpeg and ffprobe from the [official page](https://www.ffmpeg.org/download.html)
3. Place the appropriate ffmpeg and ffprobe binaries for your platform either:
- Next to the thumbnailer binary
- On your PATH

## Running

To generate contact sheets run `thumbnailer $FILENAME`.

By default, contact sheets will be written next to the video file. This can be disabled via the `in-place` flag.

See `thumbnailer -h` for a complete list of options.

0 comments on commit 1d2f462

Please sign in to comment.