README.md

   1 A silly idea for producing animated ascii art.
   2
   3 Usage
   4 =====
   5 The `load` function will load a text file and proceed to animate it:
   6
   7 ```python
   8 import animate
   9 animate.load("dance.txt")
  10 ```
  11
  12 You can optionally add a message to the animation:
  13
  14 ```python
  15 import animate
  16 animate.load("dance.txt", "Nice Meme!")
  17 ```
  18
  19 Text File Format
  20 ================
  21 The text file needs to include all frames of the animation.
  22
  23 The first line of the text file must contain the number of lines per frame. Following that each frame must be drawn and separated by an empty line. Each frame must have the same number of lines as specified at the beginning of the file. See applause.txt and dance.txt for examples.