Skip to content

Commit

Permalink
Clean up documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
David Karchmer committed Dec 17, 2015
1 parent 346d612 commit 19cce45
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 15 deletions.
14 changes: 8 additions & 6 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,18 @@ MAINTAINER David Karchmer <[email protected]>

#####################################################################
#
# A Docker image with everything needed to run Moviepy scripts
#
# Image based on Ubuntu:14.04
#
# with
# - Python 3.5
# - FFMPEG (built)
# - ImageMagick and other requirements for moviepy
# - Latest Python 3.5
# - Latest FFMPEG (built)
# - ImageMagick, Numpy, Scipy and other requirements for moviepy
#
# plus a bunch of build/web essentials via wheezy
# including MySQL and Postgres clients:
# https://github.com/docker-library/docs/tree/master/buildpack-deps
# For more on Moviepy, see http://zulko.github.io/moviepy/
#
# plus a bunch of build/web essentials
#
#####################################################################

Expand Down
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# docker-ffmpeg-moviepy

A Docker image running Ubuntu:trusty with latest Python 3.5 and latest FFMPEG (built from source)
Also installs moviepy and necessary packages (numpy, scipy, ImageMagick, etc.)

For more on Moviepy, see http://zulko.github.io/moviepy/
Many thanks to all the contributors of that great project.

### To Build

~~~~
Expand All @@ -11,9 +13,9 @@ docker build -t <imageName> .

### To pull and run from hub.docker.com

Docker Hub: https://registry.hub.docker.com/u/dkarchmervue/ffmpeg-moviepy/
Docker Hub: https://registry.hub.docker.com/u/dkarchmervue/moviepy/

Source and example: https://github.com/ampervue/ffmpeg-moviepy
Source and example: https://github.com/ampervue/docker-ffmpeg-moviepy

~~~~
docker pull dkarchmervue/moviepy
Expand All @@ -22,15 +24,15 @@ docker run -ti dkarchmervue/moviepy

## Example

As an example, the python script uses FFMPEG to build a mosaic of
four videos
As an example, the python script demonstrates a
Hello Work, creating a title slide for 10sec

~~~~
# Pull image
docker pull dkarchmervue/ffmpeg-moviepy
docker pull dkarchmervue/moviepy
# Get example files and build new image
git clone https://github.com/ampervue/ffmpeg-moviepy
git clone https://github.com/ampervue/docker-ffmpeg-moviepy
cd example
docker build -t example .
Expand Down
5 changes: 3 additions & 2 deletions example/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
FROM dkarchmervue/moviepy

# https://github.com/ampervue/ffmpeg-moviepy
# https://github.com/ampervue/docker-ffmpeg-moviepy
# https://hub.docker.com/r/dkarchmervue/moviepy/
# Example credits to:

MAINTAINER David Karchmer <[email protected]>

Expand All @@ -13,7 +14,7 @@ MAINTAINER David Karchmer <[email protected]>
# docker pull dkarchmervue/moviepy
#
# # Get example files and build new image
# git clone https://github.com/ampervue/ffmpeg-moviepy
# git clone https://github.com/ampervue/docker-ffmpeg-moviepy
# cd example
# docker build -t example .
#
Expand Down

0 comments on commit 19cce45

Please sign in to comment.