~warmwaffles/gopro-utils

639b74498f467cad368e574dc342ee0cbbc13a7d — Matthew Johnston 5 months ago d5a3284
Update readme with requirements and timelapse documentation
1 files changed, 25 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +25 -0
@@ 3,8 3,33 @@
A tool to help aid in the organization and automation of your GoPro file
importing.

## Requirements

* python 3+
* [ffmpeg](https://git.ffmpeg.org/ffmpeg.git)
* [jpegoptim](https://github.com/tjko/jpegoptim)
* [jpeginfo](https://github.com/tjko/jpeginfo)

## Installation

Copy the `gopro` file somewhere into your path.

Or simply execute it with `python path/to/gopro`.

## Commands

### `timelapse`

Converts the timelapse images into a single `mp4` file.

#### Options

* `--fps` - Set the frames per second you wish the timelapse to use. Default
  is 30 fps.
* `--output-dir` - The output directory to store the `mp4` file.
* `--name` - The name of the timelapse file without the extension. Default is
  the parent directory name.
* `--width` - The final width of the video.
* `--height` - The final height of the video.
* `--rotate` - The amount of degrees to rotate the video by. It is pinned to
  increments of 90 degrees.