initial commit

1 files changed, 24 insertions, 0 deletions

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..73f470a
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,24 @@
+make-gif
+========
+
+despite the recent rise of libvpx, there's still something magical about the
+humble animated gif and it's status as not-quite-video-or-image. however, given
+the limitations of the file format, creating gifs which can hold their own
+against these modern video formats is not easy.
+
+this script aims to provide a featureful frontend to
+[ffmpeg](https://ffmpeg.org/) which makes creating high-quality gifs from video
+files as painless as possible, with support for things like embedding
+subtitles, various dithering algorithms, cropping, and post-optimisation (via
+[gifsicle](https://www.lcdf.org/gifsicle/))
+
+just clone and run `make-gif --help` to get started!
+
+dependencies
+============
+
+in addition to being run via zsh, make-gif makes use the following external
+commands:
+
+* **required**: `ffmpeg`, `ffprobe`, `grep`
+* **optional**: `gifsicle`