From a57311fe669d9a4a6cedf6d27b34624e06e2c809 Mon Sep 17 00:00:00 2001 From: Diego de Las Casas Date: Fri, 6 Feb 2015 15:24:10 -0200 Subject: [PATCH] made script exectuable, added usage information in README --- README.org | 21 +++++++++++++++++++++ pulse-gif.py | 2 +- 2 files changed, 22 insertions(+), 1 deletion(-) mode change 100644 => 100755 pulse-gif.py diff --git a/README.org b/README.org index de87aa4..a6cfdbd 100644 --- a/README.org +++ b/README.org @@ -2,3 +2,24 @@ Create text pulsating in a specified frequency. Inspired in a [[http://xkcd.com/1331/][XKCD comic]]. + +Usage: +#+BEGIN_SRC bash + pulse-gif.py [-h] [--frequency F] [--output FILENAME] Text [Text ...] + #+END_SRC + +positional arguments: +- Text :: The text you want printed in the gif image. + +optional arguments: +- -h, --help :: show this help message and exit +- --frequency F, -f F :: Frequency (per second) of the pulse. Default: 0.25. +- --output FILENAME, -o FILENAME :: + Filename of the resulting gif. If the .gif sufix is + not present it is added automaticaly. Default: pulse.gif) + +Dependencies: +- ImageMagick +- Python Image Library (PIL) + + diff --git a/pulse-gif.py b/pulse-gif.py old mode 100644 new mode 100755 index 8c69d4f..9202976 --- a/pulse-gif.py +++ b/pulse-gif.py @@ -1,4 +1,4 @@ -# NOTE: Requires ImageMagick +#!/usr/bin/env python from __future__ import division import sys, os import argparse