Skip to content

Commit

Permalink
made script exectuable, added usage information in README
Browse files Browse the repository at this point in the history
  • Loading branch information
diegolascasas committed Feb 6, 2015
1 parent 25123af commit a57311f
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
21 changes: 21 additions & 0 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -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)


2 changes: 1 addition & 1 deletion pulse-gif.py
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# NOTE: Requires ImageMagick
#!/usr/bin/env python
from __future__ import division
import sys, os
import argparse
Expand Down

0 comments on commit a57311f

Please sign in to comment.