Initial commit

1 files changed, 16 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6f4867d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# torch-warp
+
+This repository contains a torch implementation for applying optical flow deformations to pairs of images in order to morph between images. The optical flow calculation and loading code is from [`manuelruder/artistic-videos`](https://github.com/manuelruder/artistic-videos), and is based on [DeepFlow](http://lear.inrialpes.fr/src/deepflow/). Theoretically, you could drop in another optical flow program which outputs `.flo` files in the [Middlebury format](http://vision.middlebury.edu/flow/data/).
+
+## Dependencies
+
+* torch7
+* DeepFlow and DeepMatching binaries in the current directory, as `deepflow2-static` and `deepmatching-static`
+
+I had very little luck getting DeepFlow to work on OS X, so I'm using a Docker image to run this.
+
+## Usage
+
+For input, you need two PNG images of the same dimensions named e.g. `filename_0.png` and `filename_1.png`. You can then run `./run-torchwarp.sh filename` to run all the steps and output the morphing animation as `morphed_filename.gif`.
+
+You can also use `./run-stereogranimator.sh ID` with an image ID from [NYPL's Stereogranimator](http://stereo.nypl.org/) to download an animated GIF and run it through the morphing process.